class_particleprocessmaterial.rst 109 KB

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