class_particleprocessmaterial.rst 109 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034
  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/4.0/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.0/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. Particle properties for :ref:`GPUParticles3D<class_GPUParticles3D>` and :ref:`GPUParticles2D<class_GPUParticles2D>` 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 :ref:`GPUParticles3D<class_GPUParticles3D>` and :ref:`GPUParticles2D<class_GPUParticles2D>` emitter nodes.
  15. Some of this material's properties are applied to each particle when emitted, while others can have a :ref:`CurveTexture<class_CurveTexture>` applied to vary values over the lifetime of the particle.
  16. Particle animation is available only in :ref:`GPUParticles2D<class_GPUParticles2D>`. To use it, attach a :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`, with :ref:`CanvasItemMaterial.particles_animation<class_CanvasItemMaterial_property_particles_animation>` enabled, to the particles node.
  17. .. rst-class:: classref-reftable-group
  18. Properties
  19. ----------
  20. .. table::
  21. :widths: auto
  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:`Vector3<class_Vector3>` | :ref:`emission_box_extents<class_ParticleProcessMaterial_property_emission_box_extents>` | |
  72. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  73. | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_color_texture<class_ParticleProcessMaterial_property_emission_color_texture>` | |
  74. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  75. | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_normal_texture<class_ParticleProcessMaterial_property_emission_normal_texture>` | |
  76. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  77. | :ref:`int<class_int>` | :ref:`emission_point_count<class_ParticleProcessMaterial_property_emission_point_count>` | |
  78. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  79. | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_point_texture<class_ParticleProcessMaterial_property_emission_point_texture>` | |
  80. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  81. | :ref:`Vector3<class_Vector3>` | :ref:`emission_ring_axis<class_ParticleProcessMaterial_property_emission_ring_axis>` | |
  82. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  83. | :ref:`float<class_float>` | :ref:`emission_ring_height<class_ParticleProcessMaterial_property_emission_ring_height>` | |
  84. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  85. | :ref:`float<class_float>` | :ref:`emission_ring_inner_radius<class_ParticleProcessMaterial_property_emission_ring_inner_radius>` | |
  86. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  87. | :ref:`float<class_float>` | :ref:`emission_ring_radius<class_ParticleProcessMaterial_property_emission_ring_radius>` | |
  88. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  89. | :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` | :ref:`emission_shape<class_ParticleProcessMaterial_property_emission_shape>` | ``0`` |
  90. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  91. | :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_ParticleProcessMaterial_property_emission_sphere_radius>` | |
  92. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  93. | :ref:`float<class_float>` | :ref:`flatness<class_ParticleProcessMaterial_property_flatness>` | ``0.0`` |
  94. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  95. | :ref:`Vector3<class_Vector3>` | :ref:`gravity<class_ParticleProcessMaterial_property_gravity>` | ``Vector3(0, -9.8, 0)`` |
  96. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  97. | :ref:`Texture2D<class_Texture2D>` | :ref:`hue_variation_curve<class_ParticleProcessMaterial_property_hue_variation_curve>` | |
  98. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  99. | :ref:`float<class_float>` | :ref:`hue_variation_max<class_ParticleProcessMaterial_property_hue_variation_max>` | ``0.0`` |
  100. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  101. | :ref:`float<class_float>` | :ref:`hue_variation_min<class_ParticleProcessMaterial_property_hue_variation_min>` | ``0.0`` |
  102. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  103. | :ref:`float<class_float>` | :ref:`initial_velocity_max<class_ParticleProcessMaterial_property_initial_velocity_max>` | ``0.0`` |
  104. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  105. | :ref:`float<class_float>` | :ref:`initial_velocity_min<class_ParticleProcessMaterial_property_initial_velocity_min>` | ``0.0`` |
  106. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  107. | :ref:`float<class_float>` | :ref:`lifetime_randomness<class_ParticleProcessMaterial_property_lifetime_randomness>` | ``0.0`` |
  108. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  109. | :ref:`Texture2D<class_Texture2D>` | :ref:`linear_accel_curve<class_ParticleProcessMaterial_property_linear_accel_curve>` | |
  110. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  111. | :ref:`float<class_float>` | :ref:`linear_accel_max<class_ParticleProcessMaterial_property_linear_accel_max>` | ``0.0`` |
  112. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  113. | :ref:`float<class_float>` | :ref:`linear_accel_min<class_ParticleProcessMaterial_property_linear_accel_min>` | ``0.0`` |
  114. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  115. | :ref:`Texture2D<class_Texture2D>` | :ref:`orbit_velocity_curve<class_ParticleProcessMaterial_property_orbit_velocity_curve>` | |
  116. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  117. | :ref:`float<class_float>` | :ref:`orbit_velocity_max<class_ParticleProcessMaterial_property_orbit_velocity_max>` | |
  118. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  119. | :ref:`float<class_float>` | :ref:`orbit_velocity_min<class_ParticleProcessMaterial_property_orbit_velocity_min>` | |
  120. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  121. | :ref:`bool<class_bool>` | :ref:`particle_flag_align_y<class_ParticleProcessMaterial_property_particle_flag_align_y>` | ``false`` |
  122. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  123. | :ref:`bool<class_bool>` | :ref:`particle_flag_disable_z<class_ParticleProcessMaterial_property_particle_flag_disable_z>` | ``false`` |
  124. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  125. | :ref:`bool<class_bool>` | :ref:`particle_flag_rotate_y<class_ParticleProcessMaterial_property_particle_flag_rotate_y>` | ``false`` |
  126. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  127. | :ref:`Texture2D<class_Texture2D>` | :ref:`radial_accel_curve<class_ParticleProcessMaterial_property_radial_accel_curve>` | |
  128. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  129. | :ref:`float<class_float>` | :ref:`radial_accel_max<class_ParticleProcessMaterial_property_radial_accel_max>` | ``0.0`` |
  130. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  131. | :ref:`float<class_float>` | :ref:`radial_accel_min<class_ParticleProcessMaterial_property_radial_accel_min>` | ``0.0`` |
  132. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  133. | :ref:`Texture2D<class_Texture2D>` | :ref:`scale_curve<class_ParticleProcessMaterial_property_scale_curve>` | |
  134. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  135. | :ref:`float<class_float>` | :ref:`scale_max<class_ParticleProcessMaterial_property_scale_max>` | ``1.0`` |
  136. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  137. | :ref:`float<class_float>` | :ref:`scale_min<class_ParticleProcessMaterial_property_scale_min>` | ``1.0`` |
  138. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  139. | :ref:`float<class_float>` | :ref:`spread<class_ParticleProcessMaterial_property_spread>` | ``45.0`` |
  140. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  141. | :ref:`int<class_int>` | :ref:`sub_emitter_amount_at_collision<class_ParticleProcessMaterial_property_sub_emitter_amount_at_collision>` | |
  142. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  143. | :ref:`int<class_int>` | :ref:`sub_emitter_amount_at_end<class_ParticleProcessMaterial_property_sub_emitter_amount_at_end>` | |
  144. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  145. | :ref:`float<class_float>` | :ref:`sub_emitter_frequency<class_ParticleProcessMaterial_property_sub_emitter_frequency>` | |
  146. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  147. | :ref:`bool<class_bool>` | :ref:`sub_emitter_keep_velocity<class_ParticleProcessMaterial_property_sub_emitter_keep_velocity>` | ``false`` |
  148. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  149. | :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` | :ref:`sub_emitter_mode<class_ParticleProcessMaterial_property_sub_emitter_mode>` | ``0`` |
  150. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  151. | :ref:`Texture2D<class_Texture2D>` | :ref:`tangential_accel_curve<class_ParticleProcessMaterial_property_tangential_accel_curve>` | |
  152. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  153. | :ref:`float<class_float>` | :ref:`tangential_accel_max<class_ParticleProcessMaterial_property_tangential_accel_max>` | ``0.0`` |
  154. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  155. | :ref:`float<class_float>` | :ref:`tangential_accel_min<class_ParticleProcessMaterial_property_tangential_accel_min>` | ``0.0`` |
  156. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  157. | :ref:`bool<class_bool>` | :ref:`turbulence_enabled<class_ParticleProcessMaterial_property_turbulence_enabled>` | ``false`` |
  158. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  159. | :ref:`float<class_float>` | :ref:`turbulence_influence_max<class_ParticleProcessMaterial_property_turbulence_influence_max>` | ``0.1`` |
  160. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  161. | :ref:`float<class_float>` | :ref:`turbulence_influence_min<class_ParticleProcessMaterial_property_turbulence_influence_min>` | ``0.1`` |
  162. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  163. | :ref:`Texture2D<class_Texture2D>` | :ref:`turbulence_influence_over_life<class_ParticleProcessMaterial_property_turbulence_influence_over_life>` | |
  164. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  165. | :ref:`float<class_float>` | :ref:`turbulence_initial_displacement_max<class_ParticleProcessMaterial_property_turbulence_initial_displacement_max>` | ``0.0`` |
  166. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  167. | :ref:`float<class_float>` | :ref:`turbulence_initial_displacement_min<class_ParticleProcessMaterial_property_turbulence_initial_displacement_min>` | ``0.0`` |
  168. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  169. | :ref:`float<class_float>` | :ref:`turbulence_noise_scale<class_ParticleProcessMaterial_property_turbulence_noise_scale>` | ``9.0`` |
  170. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  171. | :ref:`Vector3<class_Vector3>` | :ref:`turbulence_noise_speed<class_ParticleProcessMaterial_property_turbulence_noise_speed>` | ``Vector3(0.5, 0.5, 0.5)`` |
  172. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  173. | :ref:`float<class_float>` | :ref:`turbulence_noise_speed_random<class_ParticleProcessMaterial_property_turbulence_noise_speed_random>` | ``0.0`` |
  174. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  175. | :ref:`float<class_float>` | :ref:`turbulence_noise_strength<class_ParticleProcessMaterial_property_turbulence_noise_strength>` | ``1.0`` |
  176. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
  177. .. rst-class:: classref-reftable-group
  178. Methods
  179. -------
  180. .. table::
  181. :widths: auto
  182. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | :ref:`float<class_float>` | :ref:`get_param_max<class_ParticleProcessMaterial_method_get_param_max>` **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const| |
  184. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | :ref:`float<class_float>` | :ref:`get_param_min<class_ParticleProcessMaterial_method_get_param_min>` **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const| |
  186. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | :ref:`Texture2D<class_Texture2D>` | :ref:`get_param_texture<class_ParticleProcessMaterial_method_get_param_texture>` **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const| |
  188. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | :ref:`bool<class_bool>` | :ref:`get_particle_flag<class_ParticleProcessMaterial_method_get_particle_flag>` **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag **)** |const| |
  190. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | void | :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>` **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)** |
  192. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | void | :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>` **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)** |
  194. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | void | :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)** |
  196. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | void | :ref:`set_particle_flag<class_ParticleProcessMaterial_method_set_particle_flag>` **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag, :ref:`bool<class_bool>` enable **)** |
  198. +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. .. rst-class:: classref-section-separator
  200. ----
  201. .. rst-class:: classref-descriptions-group
  202. Enumerations
  203. ------------
  204. .. _enum_ParticleProcessMaterial_Parameter:
  205. .. rst-class:: classref-enumeration
  206. enum **Parameter**:
  207. .. _class_ParticleProcessMaterial_constant_PARAM_INITIAL_LINEAR_VELOCITY:
  208. .. rst-class:: classref-enumeration-constant
  209. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_INITIAL_LINEAR_VELOCITY** = ``0``
  210. 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.
  211. .. _class_ParticleProcessMaterial_constant_PARAM_ANGULAR_VELOCITY:
  212. .. rst-class:: classref-enumeration-constant
  213. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANGULAR_VELOCITY** = ``1``
  214. 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.
  215. .. _class_ParticleProcessMaterial_constant_PARAM_ORBIT_VELOCITY:
  216. .. rst-class:: classref-enumeration-constant
  217. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ORBIT_VELOCITY** = ``2``
  218. 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.
  219. .. _class_ParticleProcessMaterial_constant_PARAM_LINEAR_ACCEL:
  220. .. rst-class:: classref-enumeration-constant
  221. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_LINEAR_ACCEL** = ``3``
  222. 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.
  223. .. _class_ParticleProcessMaterial_constant_PARAM_RADIAL_ACCEL:
  224. .. rst-class:: classref-enumeration-constant
  225. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_RADIAL_ACCEL** = ``4``
  226. 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.
  227. .. _class_ParticleProcessMaterial_constant_PARAM_TANGENTIAL_ACCEL:
  228. .. rst-class:: classref-enumeration-constant
  229. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TANGENTIAL_ACCEL** = ``5``
  230. 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.
  231. .. _class_ParticleProcessMaterial_constant_PARAM_DAMPING:
  232. .. rst-class:: classref-enumeration-constant
  233. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_DAMPING** = ``6``
  234. 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.
  235. .. _class_ParticleProcessMaterial_constant_PARAM_ANGLE:
  236. .. rst-class:: classref-enumeration-constant
  237. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANGLE** = ``7``
  238. 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.
  239. .. _class_ParticleProcessMaterial_constant_PARAM_SCALE:
  240. .. rst-class:: classref-enumeration-constant
  241. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_SCALE** = ``8``
  242. 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.
  243. .. _class_ParticleProcessMaterial_constant_PARAM_HUE_VARIATION:
  244. .. rst-class:: classref-enumeration-constant
  245. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_HUE_VARIATION** = ``9``
  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 hue variation properties.
  247. .. _class_ParticleProcessMaterial_constant_PARAM_ANIM_SPEED:
  248. .. rst-class:: classref-enumeration-constant
  249. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANIM_SPEED** = ``10``
  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 animation speed properties.
  251. .. _class_ParticleProcessMaterial_constant_PARAM_ANIM_OFFSET:
  252. .. rst-class:: classref-enumeration-constant
  253. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANIM_OFFSET** = ``11``
  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 animation offset properties.
  255. .. _class_ParticleProcessMaterial_constant_PARAM_MAX:
  256. .. rst-class:: classref-enumeration-constant
  257. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_MAX** = ``15``
  258. Represents the size of the :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` enum.
  259. .. _class_ParticleProcessMaterial_constant_PARAM_TURB_VEL_INFLUENCE:
  260. .. rst-class:: classref-enumeration-constant
  261. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TURB_VEL_INFLUENCE** = ``13``
  262. 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.
  263. .. _class_ParticleProcessMaterial_constant_PARAM_TURB_INIT_DISPLACEMENT:
  264. .. rst-class:: classref-enumeration-constant
  265. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TURB_INIT_DISPLACEMENT** = ``14``
  266. 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.
  267. .. _class_ParticleProcessMaterial_constant_PARAM_TURB_INFLUENCE_OVER_LIFE:
  268. .. rst-class:: classref-enumeration-constant
  269. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TURB_INFLUENCE_OVER_LIFE** = ``12``
  270. Use with :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set the turbulence influence over the particles life time.
  271. .. rst-class:: classref-item-separator
  272. ----
  273. .. _enum_ParticleProcessMaterial_ParticleFlags:
  274. .. rst-class:: classref-enumeration
  275. enum **ParticleFlags**:
  276. .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY:
  277. .. rst-class:: classref-enumeration-constant
  278. :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY** = ``0``
  279. 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>`.
  280. .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_ROTATE_Y:
  281. .. rst-class:: classref-enumeration-constant
  282. :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_ROTATE_Y** = ``1``
  283. 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>`.
  284. .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_DISABLE_Z:
  285. .. rst-class:: classref-enumeration-constant
  286. :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_DISABLE_Z** = ``2``
  287. 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>`.
  288. .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_MAX:
  289. .. rst-class:: classref-enumeration-constant
  290. :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_MAX** = ``3``
  291. Represents the size of the :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` enum.
  292. .. rst-class:: classref-item-separator
  293. ----
  294. .. _enum_ParticleProcessMaterial_EmissionShape:
  295. .. rst-class:: classref-enumeration
  296. enum **EmissionShape**:
  297. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINT:
  298. .. rst-class:: classref-enumeration-constant
  299. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_POINT** = ``0``
  300. All particles will be emitted from a single point.
  301. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_SPHERE:
  302. .. rst-class:: classref-enumeration-constant
  303. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_SPHERE** = ``1``
  304. Particles will be emitted in the volume of a sphere.
  305. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_SPHERE_SURFACE:
  306. .. rst-class:: classref-enumeration-constant
  307. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_SPHERE_SURFACE** = ``2``
  308. Particles will be emitted on the surface of a sphere.
  309. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_BOX:
  310. .. rst-class:: classref-enumeration-constant
  311. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_BOX** = ``3``
  312. Particles will be emitted in the volume of a box.
  313. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINTS:
  314. .. rst-class:: classref-enumeration-constant
  315. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_POINTS** = ``4``
  316. 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>`.
  317. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS:
  318. .. rst-class:: classref-enumeration-constant
  319. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_DIRECTED_POINTS** = ``5``
  320. 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>`.
  321. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING:
  322. .. rst-class:: classref-enumeration-constant
  323. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_RING** = ``6``
  324. Particles will be emitted in a ring or cylinder.
  325. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_MAX:
  326. .. rst-class:: classref-enumeration-constant
  327. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_MAX** = ``7``
  328. Represents the size of the :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` enum.
  329. .. rst-class:: classref-item-separator
  330. ----
  331. .. _enum_ParticleProcessMaterial_SubEmitterMode:
  332. .. rst-class:: classref-enumeration
  333. enum **SubEmitterMode**:
  334. .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_DISABLED:
  335. .. rst-class:: classref-enumeration-constant
  336. :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_DISABLED** = ``0``
  337. .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_CONSTANT:
  338. .. rst-class:: classref-enumeration-constant
  339. :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_CONSTANT** = ``1``
  340. .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_AT_END:
  341. .. rst-class:: classref-enumeration-constant
  342. :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_AT_END** = ``2``
  343. .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_AT_COLLISION:
  344. .. rst-class:: classref-enumeration-constant
  345. :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_AT_COLLISION** = ``3``
  346. .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_MAX:
  347. .. rst-class:: classref-enumeration-constant
  348. :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_MAX** = ``4``
  349. Represents the size of the :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` enum.
  350. .. rst-class:: classref-item-separator
  351. ----
  352. .. _enum_ParticleProcessMaterial_CollisionMode:
  353. .. rst-class:: classref-enumeration
  354. enum **CollisionMode**:
  355. .. _class_ParticleProcessMaterial_constant_COLLISION_DISABLED:
  356. .. rst-class:: classref-enumeration-constant
  357. :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_DISABLED** = ``0``
  358. No collision for particles. Particles will go through :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` nodes.
  359. .. _class_ParticleProcessMaterial_constant_COLLISION_RIGID:
  360. .. rst-class:: classref-enumeration-constant
  361. :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_RIGID** = ``1``
  362. :ref:`RigidBody3D<class_RigidBody3D>`-style collision for particles using :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` nodes.
  363. .. _class_ParticleProcessMaterial_constant_COLLISION_HIDE_ON_CONTACT:
  364. .. rst-class:: classref-enumeration-constant
  365. :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_HIDE_ON_CONTACT** = ``2``
  366. 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.
  367. .. _class_ParticleProcessMaterial_constant_COLLISION_MAX:
  368. .. rst-class:: classref-enumeration-constant
  369. :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_MAX** = ``3``
  370. Represents the size of the :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` enum.
  371. .. rst-class:: classref-section-separator
  372. ----
  373. .. rst-class:: classref-descriptions-group
  374. Property Descriptions
  375. ---------------------
  376. .. _class_ParticleProcessMaterial_property_angle_curve:
  377. .. rst-class:: classref-property
  378. :ref:`Texture2D<class_Texture2D>` **angle_curve**
  379. .. rst-class:: classref-property-setget
  380. - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
  381. - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  382. Each particle's rotation will be animated along this :ref:`CurveTexture<class_CurveTexture>`.
  383. .. rst-class:: classref-item-separator
  384. ----
  385. .. _class_ParticleProcessMaterial_property_angle_max:
  386. .. rst-class:: classref-property
  387. :ref:`float<class_float>` **angle_max** = ``0.0``
  388. .. rst-class:: classref-property-setget
  389. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  390. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  391. Maximum initial rotation applied to each particle, in degrees.
  392. 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>`.
  393. .. rst-class:: classref-item-separator
  394. ----
  395. .. _class_ParticleProcessMaterial_property_angle_min:
  396. .. rst-class:: classref-property
  397. :ref:`float<class_float>` **angle_min** = ``0.0``
  398. .. rst-class:: classref-property-setget
  399. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  400. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  401. Minimum equivalent of :ref:`angle_max<class_ParticleProcessMaterial_property_angle_max>`.
  402. .. rst-class:: classref-item-separator
  403. ----
  404. .. _class_ParticleProcessMaterial_property_angular_velocity_curve:
  405. .. rst-class:: classref-property
  406. :ref:`Texture2D<class_Texture2D>` **angular_velocity_curve**
  407. .. rst-class:: classref-property-setget
  408. - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
  409. - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  410. Each particle's angular velocity (rotation speed) will vary along this :ref:`CurveTexture<class_CurveTexture>` over its lifetime.
  411. .. rst-class:: classref-item-separator
  412. ----
  413. .. _class_ParticleProcessMaterial_property_angular_velocity_max:
  414. .. rst-class:: classref-property
  415. :ref:`float<class_float>` **angular_velocity_max** = ``0.0``
  416. .. rst-class:: classref-property-setget
  417. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  418. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  419. Maximum initial angular velocity (rotation speed) applied to each particle in *degrees* per second.
  420. 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>`.
  421. .. rst-class:: classref-item-separator
  422. ----
  423. .. _class_ParticleProcessMaterial_property_angular_velocity_min:
  424. .. rst-class:: classref-property
  425. :ref:`float<class_float>` **angular_velocity_min** = ``0.0``
  426. .. rst-class:: classref-property-setget
  427. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  428. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  429. Minimum equivalent of :ref:`angular_velocity_max<class_ParticleProcessMaterial_property_angular_velocity_max>`.
  430. .. rst-class:: classref-item-separator
  431. ----
  432. .. _class_ParticleProcessMaterial_property_anim_offset_curve:
  433. .. rst-class:: classref-property
  434. :ref:`Texture2D<class_Texture2D>` **anim_offset_curve**
  435. .. rst-class:: classref-property-setget
  436. - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
  437. - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  438. Each particle's animation offset will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  439. .. rst-class:: classref-item-separator
  440. ----
  441. .. _class_ParticleProcessMaterial_property_anim_offset_max:
  442. .. rst-class:: classref-property
  443. :ref:`float<class_float>` **anim_offset_max** = ``0.0``
  444. .. rst-class:: classref-property-setget
  445. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  446. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  447. 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>`.
  448. .. rst-class:: classref-item-separator
  449. ----
  450. .. _class_ParticleProcessMaterial_property_anim_offset_min:
  451. .. rst-class:: classref-property
  452. :ref:`float<class_float>` **anim_offset_min** = ``0.0``
  453. .. rst-class:: classref-property-setget
  454. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  455. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  456. Minimum equivalent of :ref:`anim_offset_max<class_ParticleProcessMaterial_property_anim_offset_max>`.
  457. .. rst-class:: classref-item-separator
  458. ----
  459. .. _class_ParticleProcessMaterial_property_anim_speed_curve:
  460. .. rst-class:: classref-property
  461. :ref:`Texture2D<class_Texture2D>` **anim_speed_curve**
  462. .. rst-class:: classref-property-setget
  463. - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
  464. - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  465. Each particle's animation speed will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  466. .. rst-class:: classref-item-separator
  467. ----
  468. .. _class_ParticleProcessMaterial_property_anim_speed_max:
  469. .. rst-class:: classref-property
  470. :ref:`float<class_float>` **anim_speed_max** = ``0.0``
  471. .. rst-class:: classref-property-setget
  472. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  473. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  474. 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.
  475. 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.
  476. .. rst-class:: classref-item-separator
  477. ----
  478. .. _class_ParticleProcessMaterial_property_anim_speed_min:
  479. .. rst-class:: classref-property
  480. :ref:`float<class_float>` **anim_speed_min** = ``0.0``
  481. .. rst-class:: classref-property-setget
  482. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  483. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  484. Minimum equivalent of :ref:`anim_speed_max<class_ParticleProcessMaterial_property_anim_speed_max>`.
  485. .. rst-class:: classref-item-separator
  486. ----
  487. .. _class_ParticleProcessMaterial_property_attractor_interaction_enabled:
  488. .. rst-class:: classref-property
  489. :ref:`bool<class_bool>` **attractor_interaction_enabled** = ``true``
  490. .. rst-class:: classref-property-setget
  491. - void **set_attractor_interaction_enabled** **(** :ref:`bool<class_bool>` value **)**
  492. - :ref:`bool<class_bool>` **is_attractor_interaction_enabled** **(** **)**
  493. True if the interaction with particle attractors is enabled.
  494. .. rst-class:: classref-item-separator
  495. ----
  496. .. _class_ParticleProcessMaterial_property_collision_bounce:
  497. .. rst-class:: classref-property
  498. :ref:`float<class_float>` **collision_bounce**
  499. .. rst-class:: classref-property-setget
  500. - void **set_collision_bounce** **(** :ref:`float<class_float>` value **)**
  501. - :ref:`float<class_float>` **get_collision_bounce** **(** **)**
  502. 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>`.
  503. .. rst-class:: classref-item-separator
  504. ----
  505. .. _class_ParticleProcessMaterial_property_collision_friction:
  506. .. rst-class:: classref-property
  507. :ref:`float<class_float>` **collision_friction**
  508. .. rst-class:: classref-property-setget
  509. - void **set_collision_friction** **(** :ref:`float<class_float>` value **)**
  510. - :ref:`float<class_float>` **get_collision_friction** **(** **)**
  511. 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>`.
  512. .. rst-class:: classref-item-separator
  513. ----
  514. .. _class_ParticleProcessMaterial_property_collision_mode:
  515. .. rst-class:: classref-property
  516. :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **collision_mode** = ``0``
  517. .. rst-class:: classref-property-setget
  518. - void **set_collision_mode** **(** :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` value **)**
  519. - :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **get_collision_mode** **(** **)**
  520. The particles' collision mode.
  521. \ **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.
  522. \ **Note:** 2D Particles can only collide with :ref:`LightOccluder2D<class_LightOccluder2D>` nodes, not :ref:`PhysicsBody2D<class_PhysicsBody2D>` nodes.
  523. .. rst-class:: classref-item-separator
  524. ----
  525. .. _class_ParticleProcessMaterial_property_collision_use_scale:
  526. .. rst-class:: classref-property
  527. :ref:`bool<class_bool>` **collision_use_scale** = ``false``
  528. .. rst-class:: classref-property-setget
  529. - void **set_collision_use_scale** **(** :ref:`bool<class_bool>` value **)**
  530. - :ref:`bool<class_bool>` **is_collision_using_scale** **(** **)**
  531. Should collision take scale into account.
  532. .. rst-class:: classref-item-separator
  533. ----
  534. .. _class_ParticleProcessMaterial_property_color:
  535. .. rst-class:: classref-property
  536. :ref:`Color<class_Color>` **color** = ``Color(1, 1, 1, 1)``
  537. .. rst-class:: classref-property-setget
  538. - void **set_color** **(** :ref:`Color<class_Color>` value **)**
  539. - :ref:`Color<class_Color>` **get_color** **(** **)**
  540. Each particle's initial color. If the :ref:`GPUParticles2D<class_GPUParticles2D>`'s ``texture`` is defined, it will be multiplied by this color.
  541. \ **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.
  542. .. rst-class:: classref-item-separator
  543. ----
  544. .. _class_ParticleProcessMaterial_property_color_initial_ramp:
  545. .. rst-class:: classref-property
  546. :ref:`Texture2D<class_Texture2D>` **color_initial_ramp**
  547. .. rst-class:: classref-property-setget
  548. - void **set_color_initial_ramp** **(** :ref:`Texture2D<class_Texture2D>` value **)**
  549. - :ref:`Texture2D<class_Texture2D>` **get_color_initial_ramp** **(** **)**
  550. Each particle's initial color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` (multiplied with :ref:`color<class_ParticleProcessMaterial_property_color>`).
  551. \ **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.
  552. .. rst-class:: classref-item-separator
  553. ----
  554. .. _class_ParticleProcessMaterial_property_color_ramp:
  555. .. rst-class:: classref-property
  556. :ref:`Texture2D<class_Texture2D>` **color_ramp**
  557. .. rst-class:: classref-property-setget
  558. - void **set_color_ramp** **(** :ref:`Texture2D<class_Texture2D>` value **)**
  559. - :ref:`Texture2D<class_Texture2D>` **get_color_ramp** **(** **)**
  560. Each particle's color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` over its lifetime (multiplied with :ref:`color<class_ParticleProcessMaterial_property_color>`).
  561. \ **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.
  562. .. rst-class:: classref-item-separator
  563. ----
  564. .. _class_ParticleProcessMaterial_property_damping_curve:
  565. .. rst-class:: classref-property
  566. :ref:`Texture2D<class_Texture2D>` **damping_curve**
  567. .. rst-class:: classref-property-setget
  568. - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
  569. - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  570. Damping will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  571. .. rst-class:: classref-item-separator
  572. ----
  573. .. _class_ParticleProcessMaterial_property_damping_max:
  574. .. rst-class:: classref-property
  575. :ref:`float<class_float>` **damping_max** = ``0.0``
  576. .. rst-class:: classref-property-setget
  577. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  578. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  579. 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.
  580. .. rst-class:: classref-item-separator
  581. ----
  582. .. _class_ParticleProcessMaterial_property_damping_min:
  583. .. rst-class:: classref-property
  584. :ref:`float<class_float>` **damping_min** = ``0.0``
  585. .. rst-class:: classref-property-setget
  586. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  587. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  588. Minimum equivalent of :ref:`damping_max<class_ParticleProcessMaterial_property_damping_max>`.
  589. .. rst-class:: classref-item-separator
  590. ----
  591. .. _class_ParticleProcessMaterial_property_direction:
  592. .. rst-class:: classref-property
  593. :ref:`Vector3<class_Vector3>` **direction** = ``Vector3(1, 0, 0)``
  594. .. rst-class:: classref-property-setget
  595. - void **set_direction** **(** :ref:`Vector3<class_Vector3>` value **)**
  596. - :ref:`Vector3<class_Vector3>` **get_direction** **(** **)**
  597. Unit vector specifying the particles' emission direction.
  598. .. rst-class:: classref-item-separator
  599. ----
  600. .. _class_ParticleProcessMaterial_property_emission_box_extents:
  601. .. rst-class:: classref-property
  602. :ref:`Vector3<class_Vector3>` **emission_box_extents**
  603. .. rst-class:: classref-property-setget
  604. - void **set_emission_box_extents** **(** :ref:`Vector3<class_Vector3>` value **)**
  605. - :ref:`Vector3<class_Vector3>` **get_emission_box_extents** **(** **)**
  606. The box's extents if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_BOX<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_BOX>`.
  607. .. rst-class:: classref-item-separator
  608. ----
  609. .. _class_ParticleProcessMaterial_property_emission_color_texture:
  610. .. rst-class:: classref-property
  611. :ref:`Texture2D<class_Texture2D>` **emission_color_texture**
  612. .. rst-class:: classref-property-setget
  613. - void **set_emission_color_texture** **(** :ref:`Texture2D<class_Texture2D>` value **)**
  614. - :ref:`Texture2D<class_Texture2D>` **get_emission_color_texture** **(** **)**
  615. 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>`.
  616. \ **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.
  617. .. rst-class:: classref-item-separator
  618. ----
  619. .. _class_ParticleProcessMaterial_property_emission_normal_texture:
  620. .. rst-class:: classref-property
  621. :ref:`Texture2D<class_Texture2D>` **emission_normal_texture**
  622. .. rst-class:: classref-property-setget
  623. - void **set_emission_normal_texture** **(** :ref:`Texture2D<class_Texture2D>` value **)**
  624. - :ref:`Texture2D<class_Texture2D>` **get_emission_normal_texture** **(** **)**
  625. 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.
  626. .. rst-class:: classref-item-separator
  627. ----
  628. .. _class_ParticleProcessMaterial_property_emission_point_count:
  629. .. rst-class:: classref-property
  630. :ref:`int<class_int>` **emission_point_count**
  631. .. rst-class:: classref-property-setget
  632. - void **set_emission_point_count** **(** :ref:`int<class_int>` value **)**
  633. - :ref:`int<class_int>` **get_emission_point_count** **(** **)**
  634. The number of emission points if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_POINTS<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINTS>` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS>`.
  635. .. rst-class:: classref-item-separator
  636. ----
  637. .. _class_ParticleProcessMaterial_property_emission_point_texture:
  638. .. rst-class:: classref-property
  639. :ref:`Texture2D<class_Texture2D>` **emission_point_texture**
  640. .. rst-class:: classref-property-setget
  641. - void **set_emission_point_texture** **(** :ref:`Texture2D<class_Texture2D>` value **)**
  642. - :ref:`Texture2D<class_Texture2D>` **get_emission_point_texture** **(** **)**
  643. 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.
  644. .. rst-class:: classref-item-separator
  645. ----
  646. .. _class_ParticleProcessMaterial_property_emission_ring_axis:
  647. .. rst-class:: classref-property
  648. :ref:`Vector3<class_Vector3>` **emission_ring_axis**
  649. .. rst-class:: classref-property-setget
  650. - void **set_emission_ring_axis** **(** :ref:`Vector3<class_Vector3>` value **)**
  651. - :ref:`Vector3<class_Vector3>` **get_emission_ring_axis** **(** **)**
  652. The axis of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
  653. .. rst-class:: classref-item-separator
  654. ----
  655. .. _class_ParticleProcessMaterial_property_emission_ring_height:
  656. .. rst-class:: classref-property
  657. :ref:`float<class_float>` **emission_ring_height**
  658. .. rst-class:: classref-property-setget
  659. - void **set_emission_ring_height** **(** :ref:`float<class_float>` value **)**
  660. - :ref:`float<class_float>` **get_emission_ring_height** **(** **)**
  661. The height of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
  662. .. rst-class:: classref-item-separator
  663. ----
  664. .. _class_ParticleProcessMaterial_property_emission_ring_inner_radius:
  665. .. rst-class:: classref-property
  666. :ref:`float<class_float>` **emission_ring_inner_radius**
  667. .. rst-class:: classref-property-setget
  668. - void **set_emission_ring_inner_radius** **(** :ref:`float<class_float>` value **)**
  669. - :ref:`float<class_float>` **get_emission_ring_inner_radius** **(** **)**
  670. The inner radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
  671. .. rst-class:: classref-item-separator
  672. ----
  673. .. _class_ParticleProcessMaterial_property_emission_ring_radius:
  674. .. rst-class:: classref-property
  675. :ref:`float<class_float>` **emission_ring_radius**
  676. .. rst-class:: classref-property-setget
  677. - void **set_emission_ring_radius** **(** :ref:`float<class_float>` value **)**
  678. - :ref:`float<class_float>` **get_emission_ring_radius** **(** **)**
  679. The radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
  680. .. rst-class:: classref-item-separator
  681. ----
  682. .. _class_ParticleProcessMaterial_property_emission_shape:
  683. .. rst-class:: classref-property
  684. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **emission_shape** = ``0``
  685. .. rst-class:: classref-property-setget
  686. - void **set_emission_shape** **(** :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` value **)**
  687. - :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **get_emission_shape** **(** **)**
  688. Particles will be emitted inside this region. Use :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` constants for values.
  689. .. rst-class:: classref-item-separator
  690. ----
  691. .. _class_ParticleProcessMaterial_property_emission_sphere_radius:
  692. .. rst-class:: classref-property
  693. :ref:`float<class_float>` **emission_sphere_radius**
  694. .. rst-class:: classref-property-setget
  695. - void **set_emission_sphere_radius** **(** :ref:`float<class_float>` value **)**
  696. - :ref:`float<class_float>` **get_emission_sphere_radius** **(** **)**
  697. The sphere's radius if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_SPHERE<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_SPHERE>`.
  698. .. rst-class:: classref-item-separator
  699. ----
  700. .. _class_ParticleProcessMaterial_property_flatness:
  701. .. rst-class:: classref-property
  702. :ref:`float<class_float>` **flatness** = ``0.0``
  703. .. rst-class:: classref-property-setget
  704. - void **set_flatness** **(** :ref:`float<class_float>` value **)**
  705. - :ref:`float<class_float>` **get_flatness** **(** **)**
  706. Amount of :ref:`spread<class_ParticleProcessMaterial_property_spread>` along the Y axis.
  707. .. rst-class:: classref-item-separator
  708. ----
  709. .. _class_ParticleProcessMaterial_property_gravity:
  710. .. rst-class:: classref-property
  711. :ref:`Vector3<class_Vector3>` **gravity** = ``Vector3(0, -9.8, 0)``
  712. .. rst-class:: classref-property-setget
  713. - void **set_gravity** **(** :ref:`Vector3<class_Vector3>` value **)**
  714. - :ref:`Vector3<class_Vector3>` **get_gravity** **(** **)**
  715. Gravity applied to every particle.
  716. .. rst-class:: classref-item-separator
  717. ----
  718. .. _class_ParticleProcessMaterial_property_hue_variation_curve:
  719. .. rst-class:: classref-property
  720. :ref:`Texture2D<class_Texture2D>` **hue_variation_curve**
  721. .. rst-class:: classref-property-setget
  722. - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
  723. - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  724. Each particle's hue will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  725. .. rst-class:: classref-item-separator
  726. ----
  727. .. _class_ParticleProcessMaterial_property_hue_variation_max:
  728. .. rst-class:: classref-property
  729. :ref:`float<class_float>` **hue_variation_max** = ``0.0``
  730. .. rst-class:: classref-property-setget
  731. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  732. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  733. Maximum initial hue variation applied to each particle. It will shift the particle color's hue.
  734. .. rst-class:: classref-item-separator
  735. ----
  736. .. _class_ParticleProcessMaterial_property_hue_variation_min:
  737. .. rst-class:: classref-property
  738. :ref:`float<class_float>` **hue_variation_min** = ``0.0``
  739. .. rst-class:: classref-property-setget
  740. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  741. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  742. Minimum equivalent of :ref:`hue_variation_max<class_ParticleProcessMaterial_property_hue_variation_max>`.
  743. .. rst-class:: classref-item-separator
  744. ----
  745. .. _class_ParticleProcessMaterial_property_initial_velocity_max:
  746. .. rst-class:: classref-property
  747. :ref:`float<class_float>` **initial_velocity_max** = ``0.0``
  748. .. rst-class:: classref-property-setget
  749. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  750. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  751. Maximum initial velocity magnitude for each particle. Direction comes from :ref:`direction<class_ParticleProcessMaterial_property_direction>` and :ref:`spread<class_ParticleProcessMaterial_property_spread>`.
  752. .. rst-class:: classref-item-separator
  753. ----
  754. .. _class_ParticleProcessMaterial_property_initial_velocity_min:
  755. .. rst-class:: classref-property
  756. :ref:`float<class_float>` **initial_velocity_min** = ``0.0``
  757. .. rst-class:: classref-property-setget
  758. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  759. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  760. Minimum equivalent of :ref:`initial_velocity_max<class_ParticleProcessMaterial_property_initial_velocity_max>`.
  761. .. rst-class:: classref-item-separator
  762. ----
  763. .. _class_ParticleProcessMaterial_property_lifetime_randomness:
  764. .. rst-class:: classref-property
  765. :ref:`float<class_float>` **lifetime_randomness** = ``0.0``
  766. .. rst-class:: classref-property-setget
  767. - void **set_lifetime_randomness** **(** :ref:`float<class_float>` value **)**
  768. - :ref:`float<class_float>` **get_lifetime_randomness** **(** **)**
  769. Particle lifetime randomness ratio. The lifetime will be multiplied by a value interpolated between ``1.0`` and a random number less than one. For example a random ratio of ``0.4`` would scale the original lifetime between ``0.4-1.0`` of its original value.
  770. .. rst-class:: classref-item-separator
  771. ----
  772. .. _class_ParticleProcessMaterial_property_linear_accel_curve:
  773. .. rst-class:: classref-property
  774. :ref:`Texture2D<class_Texture2D>` **linear_accel_curve**
  775. .. rst-class:: classref-property-setget
  776. - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
  777. - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  778. Each particle's linear acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  779. .. rst-class:: classref-item-separator
  780. ----
  781. .. _class_ParticleProcessMaterial_property_linear_accel_max:
  782. .. rst-class:: classref-property
  783. :ref:`float<class_float>` **linear_accel_max** = ``0.0``
  784. .. rst-class:: classref-property-setget
  785. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  786. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  787. Maximum linear acceleration applied to each particle in the direction of motion.
  788. .. rst-class:: classref-item-separator
  789. ----
  790. .. _class_ParticleProcessMaterial_property_linear_accel_min:
  791. .. rst-class:: classref-property
  792. :ref:`float<class_float>` **linear_accel_min** = ``0.0``
  793. .. rst-class:: classref-property-setget
  794. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  795. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  796. Minimum equivalent of :ref:`linear_accel_max<class_ParticleProcessMaterial_property_linear_accel_max>`.
  797. .. rst-class:: classref-item-separator
  798. ----
  799. .. _class_ParticleProcessMaterial_property_orbit_velocity_curve:
  800. .. rst-class:: classref-property
  801. :ref:`Texture2D<class_Texture2D>` **orbit_velocity_curve**
  802. .. rst-class:: classref-property-setget
  803. - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
  804. - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  805. Each particle's orbital velocity will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  806. .. rst-class:: classref-item-separator
  807. ----
  808. .. _class_ParticleProcessMaterial_property_orbit_velocity_max:
  809. .. rst-class:: classref-property
  810. :ref:`float<class_float>` **orbit_velocity_max**
  811. .. rst-class:: classref-property-setget
  812. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  813. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  814. Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second.
  815. Only available when :ref:`particle_flag_disable_z<class_ParticleProcessMaterial_property_particle_flag_disable_z>` is ``true``.
  816. .. rst-class:: classref-item-separator
  817. ----
  818. .. _class_ParticleProcessMaterial_property_orbit_velocity_min:
  819. .. rst-class:: classref-property
  820. :ref:`float<class_float>` **orbit_velocity_min**
  821. .. rst-class:: classref-property-setget
  822. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  823. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  824. Minimum equivalent of :ref:`orbit_velocity_max<class_ParticleProcessMaterial_property_orbit_velocity_max>`.
  825. .. rst-class:: classref-item-separator
  826. ----
  827. .. _class_ParticleProcessMaterial_property_particle_flag_align_y:
  828. .. rst-class:: classref-property
  829. :ref:`bool<class_bool>` **particle_flag_align_y** = ``false``
  830. .. rst-class:: classref-property-setget
  831. - void **set_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag, :ref:`bool<class_bool>` enable **)**
  832. - :ref:`bool<class_bool>` **get_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag **)** |const|
  833. Align Y axis of particle with the direction of its velocity.
  834. .. rst-class:: classref-item-separator
  835. ----
  836. .. _class_ParticleProcessMaterial_property_particle_flag_disable_z:
  837. .. rst-class:: classref-property
  838. :ref:`bool<class_bool>` **particle_flag_disable_z** = ``false``
  839. .. rst-class:: classref-property-setget
  840. - void **set_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag, :ref:`bool<class_bool>` enable **)**
  841. - :ref:`bool<class_bool>` **get_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag **)** |const|
  842. If ``true``, particles will not move on the z axis.
  843. .. rst-class:: classref-item-separator
  844. ----
  845. .. _class_ParticleProcessMaterial_property_particle_flag_rotate_y:
  846. .. rst-class:: classref-property
  847. :ref:`bool<class_bool>` **particle_flag_rotate_y** = ``false``
  848. .. rst-class:: classref-property-setget
  849. - void **set_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag, :ref:`bool<class_bool>` enable **)**
  850. - :ref:`bool<class_bool>` **get_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag **)** |const|
  851. If ``true``, particles rotate around Y axis by :ref:`angle_min<class_ParticleProcessMaterial_property_angle_min>`.
  852. .. rst-class:: classref-item-separator
  853. ----
  854. .. _class_ParticleProcessMaterial_property_radial_accel_curve:
  855. .. rst-class:: classref-property
  856. :ref:`Texture2D<class_Texture2D>` **radial_accel_curve**
  857. .. rst-class:: classref-property-setget
  858. - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
  859. - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  860. Each particle's radial acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  861. .. rst-class:: classref-item-separator
  862. ----
  863. .. _class_ParticleProcessMaterial_property_radial_accel_max:
  864. .. rst-class:: classref-property
  865. :ref:`float<class_float>` **radial_accel_max** = ``0.0``
  866. .. rst-class:: classref-property-setget
  867. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  868. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  869. Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative.
  870. .. rst-class:: classref-item-separator
  871. ----
  872. .. _class_ParticleProcessMaterial_property_radial_accel_min:
  873. .. rst-class:: classref-property
  874. :ref:`float<class_float>` **radial_accel_min** = ``0.0``
  875. .. rst-class:: classref-property-setget
  876. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  877. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  878. Minimum equivalent of :ref:`radial_accel_max<class_ParticleProcessMaterial_property_radial_accel_max>`.
  879. .. rst-class:: classref-item-separator
  880. ----
  881. .. _class_ParticleProcessMaterial_property_scale_curve:
  882. .. rst-class:: classref-property
  883. :ref:`Texture2D<class_Texture2D>` **scale_curve**
  884. .. rst-class:: classref-property-setget
  885. - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
  886. - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  887. 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.
  888. .. rst-class:: classref-item-separator
  889. ----
  890. .. _class_ParticleProcessMaterial_property_scale_max:
  891. .. rst-class:: classref-property
  892. :ref:`float<class_float>` **scale_max** = ``1.0``
  893. .. rst-class:: classref-property-setget
  894. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  895. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  896. Maximum initial scale applied to each particle.
  897. .. rst-class:: classref-item-separator
  898. ----
  899. .. _class_ParticleProcessMaterial_property_scale_min:
  900. .. rst-class:: classref-property
  901. :ref:`float<class_float>` **scale_min** = ``1.0``
  902. .. rst-class:: classref-property-setget
  903. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  904. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  905. Minimum equivalent of :ref:`scale_max<class_ParticleProcessMaterial_property_scale_max>`.
  906. .. rst-class:: classref-item-separator
  907. ----
  908. .. _class_ParticleProcessMaterial_property_spread:
  909. .. rst-class:: classref-property
  910. :ref:`float<class_float>` **spread** = ``45.0``
  911. .. rst-class:: classref-property-setget
  912. - void **set_spread** **(** :ref:`float<class_float>` value **)**
  913. - :ref:`float<class_float>` **get_spread** **(** **)**
  914. Each particle's initial direction range from ``+spread`` to ``-spread`` degrees.
  915. .. rst-class:: classref-item-separator
  916. ----
  917. .. _class_ParticleProcessMaterial_property_sub_emitter_amount_at_collision:
  918. .. rst-class:: classref-property
  919. :ref:`int<class_int>` **sub_emitter_amount_at_collision**
  920. .. rst-class:: classref-property-setget
  921. - void **set_sub_emitter_amount_at_collision** **(** :ref:`int<class_int>` value **)**
  922. - :ref:`int<class_int>` **get_sub_emitter_amount_at_collision** **(** **)**
  923. Sub particle amount on collision.
  924. Maximum amount set in the sub particles emitter.
  925. .. rst-class:: classref-item-separator
  926. ----
  927. .. _class_ParticleProcessMaterial_property_sub_emitter_amount_at_end:
  928. .. rst-class:: classref-property
  929. :ref:`int<class_int>` **sub_emitter_amount_at_end**
  930. .. rst-class:: classref-property-setget
  931. - void **set_sub_emitter_amount_at_end** **(** :ref:`int<class_int>` value **)**
  932. - :ref:`int<class_int>` **get_sub_emitter_amount_at_end** **(** **)**
  933. .. container:: contribute
  934. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  935. .. rst-class:: classref-item-separator
  936. ----
  937. .. _class_ParticleProcessMaterial_property_sub_emitter_frequency:
  938. .. rst-class:: classref-property
  939. :ref:`float<class_float>` **sub_emitter_frequency**
  940. .. rst-class:: classref-property-setget
  941. - void **set_sub_emitter_frequency** **(** :ref:`float<class_float>` value **)**
  942. - :ref:`float<class_float>` **get_sub_emitter_frequency** **(** **)**
  943. .. container:: contribute
  944. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  945. .. rst-class:: classref-item-separator
  946. ----
  947. .. _class_ParticleProcessMaterial_property_sub_emitter_keep_velocity:
  948. .. rst-class:: classref-property
  949. :ref:`bool<class_bool>` **sub_emitter_keep_velocity** = ``false``
  950. .. rst-class:: classref-property-setget
  951. - void **set_sub_emitter_keep_velocity** **(** :ref:`bool<class_bool>` value **)**
  952. - :ref:`bool<class_bool>` **get_sub_emitter_keep_velocity** **(** **)**
  953. .. container:: contribute
  954. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  955. .. rst-class:: classref-item-separator
  956. ----
  957. .. _class_ParticleProcessMaterial_property_sub_emitter_mode:
  958. .. rst-class:: classref-property
  959. :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **sub_emitter_mode** = ``0``
  960. .. rst-class:: classref-property-setget
  961. - void **set_sub_emitter_mode** **(** :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` value **)**
  962. - :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **get_sub_emitter_mode** **(** **)**
  963. .. container:: contribute
  964. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  965. .. rst-class:: classref-item-separator
  966. ----
  967. .. _class_ParticleProcessMaterial_property_tangential_accel_curve:
  968. .. rst-class:: classref-property
  969. :ref:`Texture2D<class_Texture2D>` **tangential_accel_curve**
  970. .. rst-class:: classref-property-setget
  971. - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
  972. - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  973. Each particle's tangential acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  974. .. rst-class:: classref-item-separator
  975. ----
  976. .. _class_ParticleProcessMaterial_property_tangential_accel_max:
  977. .. rst-class:: classref-property
  978. :ref:`float<class_float>` **tangential_accel_max** = ``0.0``
  979. .. rst-class:: classref-property-setget
  980. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  981. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  982. Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
  983. .. rst-class:: classref-item-separator
  984. ----
  985. .. _class_ParticleProcessMaterial_property_tangential_accel_min:
  986. .. rst-class:: classref-property
  987. :ref:`float<class_float>` **tangential_accel_min** = ``0.0``
  988. .. rst-class:: classref-property-setget
  989. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  990. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  991. Minimum equivalent of :ref:`tangential_accel_max<class_ParticleProcessMaterial_property_tangential_accel_max>`.
  992. .. rst-class:: classref-item-separator
  993. ----
  994. .. _class_ParticleProcessMaterial_property_turbulence_enabled:
  995. .. rst-class:: classref-property
  996. :ref:`bool<class_bool>` **turbulence_enabled** = ``false``
  997. .. rst-class:: classref-property-setget
  998. - void **set_turbulence_enabled** **(** :ref:`bool<class_bool>` value **)**
  999. - :ref:`bool<class_bool>` **get_turbulence_enabled** **(** **)**
  1000. 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).
  1001. \ **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.
  1002. .. rst-class:: classref-item-separator
  1003. ----
  1004. .. _class_ParticleProcessMaterial_property_turbulence_influence_max:
  1005. .. rst-class:: classref-property
  1006. :ref:`float<class_float>` **turbulence_influence_max** = ``0.1``
  1007. .. rst-class:: classref-property-setget
  1008. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  1009. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  1010. Maximum turbulence influence on each particle.
  1011. 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>`.
  1012. .. rst-class:: classref-item-separator
  1013. ----
  1014. .. _class_ParticleProcessMaterial_property_turbulence_influence_min:
  1015. .. rst-class:: classref-property
  1016. :ref:`float<class_float>` **turbulence_influence_min** = ``0.1``
  1017. .. rst-class:: classref-property-setget
  1018. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  1019. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  1020. Minimum turbulence influence on each particle.
  1021. 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>`.
  1022. .. rst-class:: classref-item-separator
  1023. ----
  1024. .. _class_ParticleProcessMaterial_property_turbulence_influence_over_life:
  1025. .. rst-class:: classref-property
  1026. :ref:`Texture2D<class_Texture2D>` **turbulence_influence_over_life**
  1027. .. rst-class:: classref-property-setget
  1028. - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
  1029. - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  1030. Each particle's amount of turbulence will be influenced along this :ref:`CurveTexture<class_CurveTexture>` over its life time.
  1031. .. rst-class:: classref-item-separator
  1032. ----
  1033. .. _class_ParticleProcessMaterial_property_turbulence_initial_displacement_max:
  1034. .. rst-class:: classref-property
  1035. :ref:`float<class_float>` **turbulence_initial_displacement_max** = ``0.0``
  1036. .. rst-class:: classref-property-setget
  1037. - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  1038. - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  1039. Maximum displacement of each particle's spawn position by the turbulence.
  1040. 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>`.
  1041. .. rst-class:: classref-item-separator
  1042. ----
  1043. .. _class_ParticleProcessMaterial_property_turbulence_initial_displacement_min:
  1044. .. rst-class:: classref-property
  1045. :ref:`float<class_float>` **turbulence_initial_displacement_min** = ``0.0``
  1046. .. rst-class:: classref-property-setget
  1047. - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  1048. - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  1049. Minimum displacement of each particle's spawn position by the turbulence.
  1050. 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>`.
  1051. .. rst-class:: classref-item-separator
  1052. ----
  1053. .. _class_ParticleProcessMaterial_property_turbulence_noise_scale:
  1054. .. rst-class:: classref-property
  1055. :ref:`float<class_float>` **turbulence_noise_scale** = ``9.0``
  1056. .. rst-class:: classref-property-setget
  1057. - void **set_turbulence_noise_scale** **(** :ref:`float<class_float>` value **)**
  1058. - :ref:`float<class_float>` **get_turbulence_noise_scale** **(** **)**
  1059. This value controls the overall scale/frequency of the turbulence noise pattern.
  1060. A small scale will result in smaller features with more detail while a high scale will result in smoother noise with larger features.
  1061. .. rst-class:: classref-item-separator
  1062. ----
  1063. .. _class_ParticleProcessMaterial_property_turbulence_noise_speed:
  1064. .. rst-class:: classref-property
  1065. :ref:`Vector3<class_Vector3>` **turbulence_noise_speed** = ``Vector3(0.5, 0.5, 0.5)``
  1066. .. rst-class:: classref-property-setget
  1067. - void **set_turbulence_noise_speed** **(** :ref:`Vector3<class_Vector3>` value **)**
  1068. - :ref:`Vector3<class_Vector3>` **get_turbulence_noise_speed** **(** **)**
  1069. The movement speed of the turbulence pattern. This changes how quickly the noise changes over time.
  1070. A value of ``Vector3(0.0, 0.0, 0.0)`` will freeze the turbulence pattern in place.
  1071. .. rst-class:: classref-item-separator
  1072. ----
  1073. .. _class_ParticleProcessMaterial_property_turbulence_noise_speed_random:
  1074. .. rst-class:: classref-property
  1075. :ref:`float<class_float>` **turbulence_noise_speed_random** = ``0.0``
  1076. .. rst-class:: classref-property-setget
  1077. - void **set_turbulence_noise_speed_random** **(** :ref:`float<class_float>` value **)**
  1078. - :ref:`float<class_float>` **get_turbulence_noise_speed_random** **(** **)**
  1079. Use to influence the noise speed in a random pattern. This helps break up visible movement patterns.
  1080. .. rst-class:: classref-item-separator
  1081. ----
  1082. .. _class_ParticleProcessMaterial_property_turbulence_noise_strength:
  1083. .. rst-class:: classref-property
  1084. :ref:`float<class_float>` **turbulence_noise_strength** = ``1.0``
  1085. .. rst-class:: classref-property-setget
  1086. - void **set_turbulence_noise_strength** **(** :ref:`float<class_float>` value **)**
  1087. - :ref:`float<class_float>` **get_turbulence_noise_strength** **(** **)**
  1088. The turbulence noise strength. Increasing this will result in a stronger, more contrasting noise pattern.
  1089. .. rst-class:: classref-section-separator
  1090. ----
  1091. .. rst-class:: classref-descriptions-group
  1092. Method Descriptions
  1093. -------------------
  1094. .. _class_ParticleProcessMaterial_method_get_param_max:
  1095. .. rst-class:: classref-method
  1096. :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  1097. Returns the maximum value range for the given parameter.
  1098. .. rst-class:: classref-item-separator
  1099. ----
  1100. .. _class_ParticleProcessMaterial_method_get_param_min:
  1101. .. rst-class:: classref-method
  1102. :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  1103. Returns the minimum value range for the given parameter.
  1104. .. rst-class:: classref-item-separator
  1105. ----
  1106. .. _class_ParticleProcessMaterial_method_get_param_texture:
  1107. .. rst-class:: classref-method
  1108. :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
  1109. Returns the :ref:`Texture2D<class_Texture2D>` used by the specified parameter.
  1110. .. rst-class:: classref-item-separator
  1111. ----
  1112. .. _class_ParticleProcessMaterial_method_get_particle_flag:
  1113. .. rst-class:: classref-method
  1114. :ref:`bool<class_bool>` **get_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag **)** |const|
  1115. Returns ``true`` if the specified particle flag is enabled. See :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` for options.
  1116. .. rst-class:: classref-item-separator
  1117. ----
  1118. .. _class_ParticleProcessMaterial_method_set_param_max:
  1119. .. rst-class:: classref-method
  1120. void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  1121. Sets the maximum value range for the given parameter.
  1122. .. rst-class:: classref-item-separator
  1123. ----
  1124. .. _class_ParticleProcessMaterial_method_set_param_min:
  1125. .. rst-class:: classref-method
  1126. void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  1127. Sets the minimum value range for the given parameter.
  1128. .. rst-class:: classref-item-separator
  1129. ----
  1130. .. _class_ParticleProcessMaterial_method_set_param_texture:
  1131. .. rst-class:: classref-method
  1132. void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
  1133. Sets the :ref:`Texture2D<class_Texture2D>` for the specified :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`.
  1134. .. rst-class:: classref-item-separator
  1135. ----
  1136. .. _class_ParticleProcessMaterial_method_set_particle_flag:
  1137. .. rst-class:: classref-method
  1138. void **set_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag, :ref:`bool<class_bool>` enable **)**
  1139. If ``true``, enables the specified particle flag. See :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` for options.
  1140. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  1141. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  1142. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  1143. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  1144. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  1145. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`