class_particleprocessmaterial.rst 131 KB

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