class_particlesmaterial.rst 60 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the ParticlesMaterial.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_ParticlesMaterial:
  6. ParticlesMaterial
  7. =================
  8. **Inherits:** :ref:`Material<class_Material>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Particle properties for :ref:`Particles<class_Particles>` and :ref:`Particles2D<class_Particles2D>` nodes.
  10. Description
  11. -----------
  12. ParticlesMaterial defines particle properties and behavior. It is used in the ``process_material`` of :ref:`Particles<class_Particles>` and :ref:`Particles2D<class_Particles2D>` emitter nodes.
  13. Some of this material's properties are applied to each particle when emitted, while others can have a :ref:`CurveTexture<class_CurveTexture>` applied to vary values over the lifetime of the particle.
  14. When a randomness ratio is applied to a property it is used to scale that property by a random amount. The random ratio is used to interpolate between ``1.0`` and a random number less than one, the result is multiplied by the property to obtain the randomized property. For example a random ratio of ``0.4`` would scale the original property between ``0.4-1.0`` of its original value.
  15. Properties
  16. ----------
  17. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  18. | :ref:`float<class_float>` | :ref:`angle<class_ParticlesMaterial_property_angle>` | ``0.0`` |
  19. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  20. | :ref:`Texture<class_Texture>` | :ref:`angle_curve<class_ParticlesMaterial_property_angle_curve>` | |
  21. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  22. | :ref:`float<class_float>` | :ref:`angle_random<class_ParticlesMaterial_property_angle_random>` | ``0.0`` |
  23. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  24. | :ref:`float<class_float>` | :ref:`angular_velocity<class_ParticlesMaterial_property_angular_velocity>` | ``0.0`` |
  25. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  26. | :ref:`Texture<class_Texture>` | :ref:`angular_velocity_curve<class_ParticlesMaterial_property_angular_velocity_curve>` | |
  27. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  28. | :ref:`float<class_float>` | :ref:`angular_velocity_random<class_ParticlesMaterial_property_angular_velocity_random>` | ``0.0`` |
  29. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  30. | :ref:`float<class_float>` | :ref:`anim_offset<class_ParticlesMaterial_property_anim_offset>` | ``0.0`` |
  31. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  32. | :ref:`Texture<class_Texture>` | :ref:`anim_offset_curve<class_ParticlesMaterial_property_anim_offset_curve>` | |
  33. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  34. | :ref:`float<class_float>` | :ref:`anim_offset_random<class_ParticlesMaterial_property_anim_offset_random>` | ``0.0`` |
  35. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  36. | :ref:`float<class_float>` | :ref:`anim_speed<class_ParticlesMaterial_property_anim_speed>` | ``0.0`` |
  37. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  38. | :ref:`Texture<class_Texture>` | :ref:`anim_speed_curve<class_ParticlesMaterial_property_anim_speed_curve>` | |
  39. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  40. | :ref:`float<class_float>` | :ref:`anim_speed_random<class_ParticlesMaterial_property_anim_speed_random>` | ``0.0`` |
  41. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  42. | :ref:`Color<class_Color>` | :ref:`color<class_ParticlesMaterial_property_color>` | ``Color( 1, 1, 1, 1 )`` |
  43. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  44. | :ref:`Texture<class_Texture>` | :ref:`color_ramp<class_ParticlesMaterial_property_color_ramp>` | |
  45. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  46. | :ref:`float<class_float>` | :ref:`damping<class_ParticlesMaterial_property_damping>` | ``0.0`` |
  47. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  48. | :ref:`Texture<class_Texture>` | :ref:`damping_curve<class_ParticlesMaterial_property_damping_curve>` | |
  49. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  50. | :ref:`float<class_float>` | :ref:`damping_random<class_ParticlesMaterial_property_damping_random>` | ``0.0`` |
  51. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  52. | :ref:`Vector3<class_Vector3>` | :ref:`direction<class_ParticlesMaterial_property_direction>` | ``Vector3( 1, 0, 0 )`` |
  53. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  54. | :ref:`Vector3<class_Vector3>` | :ref:`emission_box_extents<class_ParticlesMaterial_property_emission_box_extents>` | |
  55. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  56. | :ref:`Texture<class_Texture>` | :ref:`emission_color_texture<class_ParticlesMaterial_property_emission_color_texture>` | |
  57. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  58. | :ref:`Texture<class_Texture>` | :ref:`emission_normal_texture<class_ParticlesMaterial_property_emission_normal_texture>` | |
  59. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  60. | :ref:`int<class_int>` | :ref:`emission_point_count<class_ParticlesMaterial_property_emission_point_count>` | |
  61. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  62. | :ref:`Texture<class_Texture>` | :ref:`emission_point_texture<class_ParticlesMaterial_property_emission_point_texture>` | |
  63. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  64. | :ref:`EmissionShape<enum_ParticlesMaterial_EmissionShape>` | :ref:`emission_shape<class_ParticlesMaterial_property_emission_shape>` | ``0`` |
  65. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  66. | :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_ParticlesMaterial_property_emission_sphere_radius>` | |
  67. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  68. | :ref:`bool<class_bool>` | :ref:`flag_align_y<class_ParticlesMaterial_property_flag_align_y>` | ``false`` |
  69. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  70. | :ref:`bool<class_bool>` | :ref:`flag_disable_z<class_ParticlesMaterial_property_flag_disable_z>` | ``false`` |
  71. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  72. | :ref:`bool<class_bool>` | :ref:`flag_rotate_y<class_ParticlesMaterial_property_flag_rotate_y>` | ``false`` |
  73. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  74. | :ref:`float<class_float>` | :ref:`flatness<class_ParticlesMaterial_property_flatness>` | ``0.0`` |
  75. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  76. | :ref:`Vector3<class_Vector3>` | :ref:`gravity<class_ParticlesMaterial_property_gravity>` | ``Vector3( 0, -9.8, 0 )`` |
  77. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  78. | :ref:`float<class_float>` | :ref:`hue_variation<class_ParticlesMaterial_property_hue_variation>` | ``0.0`` |
  79. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  80. | :ref:`Texture<class_Texture>` | :ref:`hue_variation_curve<class_ParticlesMaterial_property_hue_variation_curve>` | |
  81. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  82. | :ref:`float<class_float>` | :ref:`hue_variation_random<class_ParticlesMaterial_property_hue_variation_random>` | ``0.0`` |
  83. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  84. | :ref:`float<class_float>` | :ref:`initial_velocity<class_ParticlesMaterial_property_initial_velocity>` | ``0.0`` |
  85. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  86. | :ref:`float<class_float>` | :ref:`initial_velocity_random<class_ParticlesMaterial_property_initial_velocity_random>` | ``0.0`` |
  87. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  88. | :ref:`float<class_float>` | :ref:`lifetime_randomness<class_ParticlesMaterial_property_lifetime_randomness>` | ``0.0`` |
  89. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  90. | :ref:`float<class_float>` | :ref:`linear_accel<class_ParticlesMaterial_property_linear_accel>` | ``0.0`` |
  91. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  92. | :ref:`Texture<class_Texture>` | :ref:`linear_accel_curve<class_ParticlesMaterial_property_linear_accel_curve>` | |
  93. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  94. | :ref:`float<class_float>` | :ref:`linear_accel_random<class_ParticlesMaterial_property_linear_accel_random>` | ``0.0`` |
  95. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  96. | :ref:`float<class_float>` | :ref:`orbit_velocity<class_ParticlesMaterial_property_orbit_velocity>` | |
  97. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  98. | :ref:`Texture<class_Texture>` | :ref:`orbit_velocity_curve<class_ParticlesMaterial_property_orbit_velocity_curve>` | |
  99. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  100. | :ref:`float<class_float>` | :ref:`orbit_velocity_random<class_ParticlesMaterial_property_orbit_velocity_random>` | |
  101. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  102. | :ref:`float<class_float>` | :ref:`radial_accel<class_ParticlesMaterial_property_radial_accel>` | ``0.0`` |
  103. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  104. | :ref:`Texture<class_Texture>` | :ref:`radial_accel_curve<class_ParticlesMaterial_property_radial_accel_curve>` | |
  105. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  106. | :ref:`float<class_float>` | :ref:`radial_accel_random<class_ParticlesMaterial_property_radial_accel_random>` | ``0.0`` |
  107. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  108. | :ref:`float<class_float>` | :ref:`scale<class_ParticlesMaterial_property_scale>` | ``1.0`` |
  109. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  110. | :ref:`Texture<class_Texture>` | :ref:`scale_curve<class_ParticlesMaterial_property_scale_curve>` | |
  111. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  112. | :ref:`float<class_float>` | :ref:`scale_random<class_ParticlesMaterial_property_scale_random>` | ``0.0`` |
  113. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  114. | :ref:`float<class_float>` | :ref:`spread<class_ParticlesMaterial_property_spread>` | ``45.0`` |
  115. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  116. | :ref:`float<class_float>` | :ref:`tangential_accel<class_ParticlesMaterial_property_tangential_accel>` | ``0.0`` |
  117. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  118. | :ref:`Texture<class_Texture>` | :ref:`tangential_accel_curve<class_ParticlesMaterial_property_tangential_accel_curve>` | |
  119. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  120. | :ref:`float<class_float>` | :ref:`tangential_accel_random<class_ParticlesMaterial_property_tangential_accel_random>` | ``0.0`` |
  121. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  122. | :ref:`GradientTexture<class_GradientTexture>` | :ref:`trail_color_modifier<class_ParticlesMaterial_property_trail_color_modifier>` | |
  123. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  124. | :ref:`int<class_int>` | :ref:`trail_divisor<class_ParticlesMaterial_property_trail_divisor>` | ``1`` |
  125. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  126. | :ref:`CurveTexture<class_CurveTexture>` | :ref:`trail_size_modifier<class_ParticlesMaterial_property_trail_size_modifier>` | |
  127. +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+
  128. Methods
  129. -------
  130. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | :ref:`bool<class_bool>` | :ref:`get_flag<class_ParticlesMaterial_method_get_flag>` **(** :ref:`Flags<enum_ParticlesMaterial_Flags>` flag **)** |const| |
  132. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :ref:`float<class_float>` | :ref:`get_param<class_ParticlesMaterial_method_get_param>` **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** |const| |
  134. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | :ref:`float<class_float>` | :ref:`get_param_randomness<class_ParticlesMaterial_method_get_param_randomness>` **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** |const| |
  136. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | :ref:`Texture<class_Texture>` | :ref:`get_param_texture<class_ParticlesMaterial_method_get_param_texture>` **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** |const| |
  138. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | void | :ref:`set_flag<class_ParticlesMaterial_method_set_flag>` **(** :ref:`Flags<enum_ParticlesMaterial_Flags>` flag, :ref:`bool<class_bool>` enable **)** |
  140. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | void | :ref:`set_param<class_ParticlesMaterial_method_set_param>` **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`float<class_float>` value **)** |
  142. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | void | :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>` **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`float<class_float>` randomness **)** |
  144. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | void | :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`Texture<class_Texture>` texture **)** |
  146. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. Enumerations
  148. ------------
  149. .. _enum_ParticlesMaterial_Parameter:
  150. .. _class_ParticlesMaterial_constant_PARAM_INITIAL_LINEAR_VELOCITY:
  151. .. _class_ParticlesMaterial_constant_PARAM_ANGULAR_VELOCITY:
  152. .. _class_ParticlesMaterial_constant_PARAM_ORBIT_VELOCITY:
  153. .. _class_ParticlesMaterial_constant_PARAM_LINEAR_ACCEL:
  154. .. _class_ParticlesMaterial_constant_PARAM_RADIAL_ACCEL:
  155. .. _class_ParticlesMaterial_constant_PARAM_TANGENTIAL_ACCEL:
  156. .. _class_ParticlesMaterial_constant_PARAM_DAMPING:
  157. .. _class_ParticlesMaterial_constant_PARAM_ANGLE:
  158. .. _class_ParticlesMaterial_constant_PARAM_SCALE:
  159. .. _class_ParticlesMaterial_constant_PARAM_HUE_VARIATION:
  160. .. _class_ParticlesMaterial_constant_PARAM_ANIM_SPEED:
  161. .. _class_ParticlesMaterial_constant_PARAM_ANIM_OFFSET:
  162. .. _class_ParticlesMaterial_constant_PARAM_MAX:
  163. enum **Parameter**:
  164. - **PARAM_INITIAL_LINEAR_VELOCITY** = **0** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set initial velocity properties.
  165. - **PARAM_ANGULAR_VELOCITY** = **1** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set angular velocity properties.
  166. - **PARAM_ORBIT_VELOCITY** = **2** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set orbital velocity properties.
  167. - **PARAM_LINEAR_ACCEL** = **3** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set linear acceleration properties.
  168. - **PARAM_RADIAL_ACCEL** = **4** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set radial acceleration properties.
  169. - **PARAM_TANGENTIAL_ACCEL** = **5** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set tangential acceleration properties.
  170. - **PARAM_DAMPING** = **6** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set damping properties.
  171. - **PARAM_ANGLE** = **7** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set angle properties.
  172. - **PARAM_SCALE** = **8** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set scale properties.
  173. - **PARAM_HUE_VARIATION** = **9** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set hue variation properties.
  174. - **PARAM_ANIM_SPEED** = **10** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set animation speed properties.
  175. - **PARAM_ANIM_OFFSET** = **11** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set animation offset properties.
  176. - **PARAM_MAX** = **12** --- Represents the size of the :ref:`Parameter<enum_ParticlesMaterial_Parameter>` enum.
  177. ----
  178. .. _enum_ParticlesMaterial_Flags:
  179. .. _class_ParticlesMaterial_constant_FLAG_ALIGN_Y_TO_VELOCITY:
  180. .. _class_ParticlesMaterial_constant_FLAG_ROTATE_Y:
  181. .. _class_ParticlesMaterial_constant_FLAG_DISABLE_Z:
  182. .. _class_ParticlesMaterial_constant_FLAG_MAX:
  183. enum **Flags**:
  184. - **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag<class_ParticlesMaterial_method_set_flag>` to set :ref:`flag_align_y<class_ParticlesMaterial_property_flag_align_y>`.
  185. - **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag<class_ParticlesMaterial_method_set_flag>` to set :ref:`flag_rotate_y<class_ParticlesMaterial_property_flag_rotate_y>`.
  186. - **FLAG_DISABLE_Z** = **2** --- Use with :ref:`set_flag<class_ParticlesMaterial_method_set_flag>` to set :ref:`flag_disable_z<class_ParticlesMaterial_property_flag_disable_z>`.
  187. - **FLAG_MAX** = **3** --- Represents the size of the :ref:`Flags<enum_ParticlesMaterial_Flags>` enum.
  188. ----
  189. .. _enum_ParticlesMaterial_EmissionShape:
  190. .. _class_ParticlesMaterial_constant_EMISSION_SHAPE_POINT:
  191. .. _class_ParticlesMaterial_constant_EMISSION_SHAPE_SPHERE:
  192. .. _class_ParticlesMaterial_constant_EMISSION_SHAPE_BOX:
  193. .. _class_ParticlesMaterial_constant_EMISSION_SHAPE_POINTS:
  194. .. _class_ParticlesMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS:
  195. .. _class_ParticlesMaterial_constant_EMISSION_SHAPE_MAX:
  196. enum **EmissionShape**:
  197. - **EMISSION_SHAPE_POINT** = **0** --- All particles will be emitted from a single point.
  198. - **EMISSION_SHAPE_SPHERE** = **1** --- Particles will be emitted in the volume of a sphere.
  199. - **EMISSION_SHAPE_BOX** = **2** --- Particles will be emitted in the volume of a box.
  200. - **EMISSION_SHAPE_POINTS** = **3** --- Particles will be emitted at a position determined by sampling a random point on the :ref:`emission_point_texture<class_ParticlesMaterial_property_emission_point_texture>`. Particle color will be modulated by :ref:`emission_color_texture<class_ParticlesMaterial_property_emission_color_texture>`.
  201. - **EMISSION_SHAPE_DIRECTED_POINTS** = **4** --- Particles will be emitted at a position determined by sampling a random point on the :ref:`emission_point_texture<class_ParticlesMaterial_property_emission_point_texture>`. Particle velocity and rotation will be set based on :ref:`emission_normal_texture<class_ParticlesMaterial_property_emission_normal_texture>`. Particle color will be modulated by :ref:`emission_color_texture<class_ParticlesMaterial_property_emission_color_texture>`.
  202. - **EMISSION_SHAPE_MAX** = **5** --- Represents the size of the :ref:`EmissionShape<enum_ParticlesMaterial_EmissionShape>` enum.
  203. Property Descriptions
  204. ---------------------
  205. .. _class_ParticlesMaterial_property_angle:
  206. - :ref:`float<class_float>` **angle**
  207. +-----------+------------------+
  208. | *Default* | ``0.0`` |
  209. +-----------+------------------+
  210. | *Setter* | set_param(value) |
  211. +-----------+------------------+
  212. | *Getter* | get_param() |
  213. +-----------+------------------+
  214. Initial rotation applied to each particle, in degrees.
  215. Only applied when :ref:`flag_disable_z<class_ParticlesMaterial_property_flag_disable_z>` or :ref:`flag_rotate_y<class_ParticlesMaterial_property_flag_rotate_y>` are ``true`` or the :ref:`SpatialMaterial<class_SpatialMaterial>` being used to draw the particle is using :ref:`SpatialMaterial.BILLBOARD_PARTICLES<class_SpatialMaterial_constant_BILLBOARD_PARTICLES>`.
  216. ----
  217. .. _class_ParticlesMaterial_property_angle_curve:
  218. - :ref:`Texture<class_Texture>` **angle_curve**
  219. +----------+--------------------------+
  220. | *Setter* | set_param_texture(value) |
  221. +----------+--------------------------+
  222. | *Getter* | get_param_texture() |
  223. +----------+--------------------------+
  224. Each particle's rotation will be animated along this :ref:`CurveTexture<class_CurveTexture>`.
  225. ----
  226. .. _class_ParticlesMaterial_property_angle_random:
  227. - :ref:`float<class_float>` **angle_random**
  228. +-----------+-----------------------------+
  229. | *Default* | ``0.0`` |
  230. +-----------+-----------------------------+
  231. | *Setter* | set_param_randomness(value) |
  232. +-----------+-----------------------------+
  233. | *Getter* | get_param_randomness() |
  234. +-----------+-----------------------------+
  235. Rotation randomness ratio.
  236. ----
  237. .. _class_ParticlesMaterial_property_angular_velocity:
  238. - :ref:`float<class_float>` **angular_velocity**
  239. +-----------+------------------+
  240. | *Default* | ``0.0`` |
  241. +-----------+------------------+
  242. | *Setter* | set_param(value) |
  243. +-----------+------------------+
  244. | *Getter* | get_param() |
  245. +-----------+------------------+
  246. Initial angular velocity applied to each particle. Sets the speed of rotation of the particle.
  247. Only applied when :ref:`flag_disable_z<class_ParticlesMaterial_property_flag_disable_z>` or :ref:`flag_rotate_y<class_ParticlesMaterial_property_flag_rotate_y>` are ``true`` or the :ref:`SpatialMaterial<class_SpatialMaterial>` being used to draw the particle is using :ref:`SpatialMaterial.BILLBOARD_PARTICLES<class_SpatialMaterial_constant_BILLBOARD_PARTICLES>`.
  248. ----
  249. .. _class_ParticlesMaterial_property_angular_velocity_curve:
  250. - :ref:`Texture<class_Texture>` **angular_velocity_curve**
  251. +----------+--------------------------+
  252. | *Setter* | set_param_texture(value) |
  253. +----------+--------------------------+
  254. | *Getter* | get_param_texture() |
  255. +----------+--------------------------+
  256. Each particle's angular velocity will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  257. ----
  258. .. _class_ParticlesMaterial_property_angular_velocity_random:
  259. - :ref:`float<class_float>` **angular_velocity_random**
  260. +-----------+-----------------------------+
  261. | *Default* | ``0.0`` |
  262. +-----------+-----------------------------+
  263. | *Setter* | set_param_randomness(value) |
  264. +-----------+-----------------------------+
  265. | *Getter* | get_param_randomness() |
  266. +-----------+-----------------------------+
  267. Angular velocity randomness ratio.
  268. ----
  269. .. _class_ParticlesMaterial_property_anim_offset:
  270. - :ref:`float<class_float>` **anim_offset**
  271. +-----------+------------------+
  272. | *Default* | ``0.0`` |
  273. +-----------+------------------+
  274. | *Setter* | set_param(value) |
  275. +-----------+------------------+
  276. | *Getter* | get_param() |
  277. +-----------+------------------+
  278. Particle animation offset.
  279. ----
  280. .. _class_ParticlesMaterial_property_anim_offset_curve:
  281. - :ref:`Texture<class_Texture>` **anim_offset_curve**
  282. +----------+--------------------------+
  283. | *Setter* | set_param_texture(value) |
  284. +----------+--------------------------+
  285. | *Getter* | get_param_texture() |
  286. +----------+--------------------------+
  287. Each particle's animation offset will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  288. ----
  289. .. _class_ParticlesMaterial_property_anim_offset_random:
  290. - :ref:`float<class_float>` **anim_offset_random**
  291. +-----------+-----------------------------+
  292. | *Default* | ``0.0`` |
  293. +-----------+-----------------------------+
  294. | *Setter* | set_param_randomness(value) |
  295. +-----------+-----------------------------+
  296. | *Getter* | get_param_randomness() |
  297. +-----------+-----------------------------+
  298. Animation offset randomness ratio.
  299. ----
  300. .. _class_ParticlesMaterial_property_anim_speed:
  301. - :ref:`float<class_float>` **anim_speed**
  302. +-----------+------------------+
  303. | *Default* | ``0.0`` |
  304. +-----------+------------------+
  305. | *Setter* | set_param(value) |
  306. +-----------+------------------+
  307. | *Getter* | get_param() |
  308. +-----------+------------------+
  309. Particle animation speed.
  310. ----
  311. .. _class_ParticlesMaterial_property_anim_speed_curve:
  312. - :ref:`Texture<class_Texture>` **anim_speed_curve**
  313. +----------+--------------------------+
  314. | *Setter* | set_param_texture(value) |
  315. +----------+--------------------------+
  316. | *Getter* | get_param_texture() |
  317. +----------+--------------------------+
  318. Each particle's animation speed will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  319. ----
  320. .. _class_ParticlesMaterial_property_anim_speed_random:
  321. - :ref:`float<class_float>` **anim_speed_random**
  322. +-----------+-----------------------------+
  323. | *Default* | ``0.0`` |
  324. +-----------+-----------------------------+
  325. | *Setter* | set_param_randomness(value) |
  326. +-----------+-----------------------------+
  327. | *Getter* | get_param_randomness() |
  328. +-----------+-----------------------------+
  329. Animation speed randomness ratio.
  330. ----
  331. .. _class_ParticlesMaterial_property_color:
  332. - :ref:`Color<class_Color>` **color**
  333. +-----------+-------------------------+
  334. | *Default* | ``Color( 1, 1, 1, 1 )`` |
  335. +-----------+-------------------------+
  336. | *Setter* | set_color(value) |
  337. +-----------+-------------------------+
  338. | *Getter* | get_color() |
  339. +-----------+-------------------------+
  340. Each particle's initial color. If the :ref:`Particles2D<class_Particles2D>`'s ``texture`` is defined, it will be multiplied by this color. To have particle display color in a :ref:`SpatialMaterial<class_SpatialMaterial>` make sure to set :ref:`SpatialMaterial.vertex_color_use_as_albedo<class_SpatialMaterial_property_vertex_color_use_as_albedo>` to ``true``.
  341. ----
  342. .. _class_ParticlesMaterial_property_color_ramp:
  343. - :ref:`Texture<class_Texture>` **color_ramp**
  344. +----------+-----------------------+
  345. | *Setter* | set_color_ramp(value) |
  346. +----------+-----------------------+
  347. | *Getter* | get_color_ramp() |
  348. +----------+-----------------------+
  349. Each particle's color will vary along this :ref:`GradientTexture<class_GradientTexture>`.
  350. ----
  351. .. _class_ParticlesMaterial_property_damping:
  352. - :ref:`float<class_float>` **damping**
  353. +-----------+------------------+
  354. | *Default* | ``0.0`` |
  355. +-----------+------------------+
  356. | *Setter* | set_param(value) |
  357. +-----------+------------------+
  358. | *Getter* | get_param() |
  359. +-----------+------------------+
  360. The rate at which particles lose velocity.
  361. ----
  362. .. _class_ParticlesMaterial_property_damping_curve:
  363. - :ref:`Texture<class_Texture>` **damping_curve**
  364. +----------+--------------------------+
  365. | *Setter* | set_param_texture(value) |
  366. +----------+--------------------------+
  367. | *Getter* | get_param_texture() |
  368. +----------+--------------------------+
  369. Damping will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  370. ----
  371. .. _class_ParticlesMaterial_property_damping_random:
  372. - :ref:`float<class_float>` **damping_random**
  373. +-----------+-----------------------------+
  374. | *Default* | ``0.0`` |
  375. +-----------+-----------------------------+
  376. | *Setter* | set_param_randomness(value) |
  377. +-----------+-----------------------------+
  378. | *Getter* | get_param_randomness() |
  379. +-----------+-----------------------------+
  380. Damping randomness ratio.
  381. ----
  382. .. _class_ParticlesMaterial_property_direction:
  383. - :ref:`Vector3<class_Vector3>` **direction**
  384. +-----------+------------------------+
  385. | *Default* | ``Vector3( 1, 0, 0 )`` |
  386. +-----------+------------------------+
  387. | *Setter* | set_direction(value) |
  388. +-----------+------------------------+
  389. | *Getter* | get_direction() |
  390. +-----------+------------------------+
  391. Unit vector specifying the particles' emission direction.
  392. ----
  393. .. _class_ParticlesMaterial_property_emission_box_extents:
  394. - :ref:`Vector3<class_Vector3>` **emission_box_extents**
  395. +----------+---------------------------------+
  396. | *Setter* | set_emission_box_extents(value) |
  397. +----------+---------------------------------+
  398. | *Getter* | get_emission_box_extents() |
  399. +----------+---------------------------------+
  400. The box's extents if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_BOX<class_ParticlesMaterial_constant_EMISSION_SHAPE_BOX>`.
  401. ----
  402. .. _class_ParticlesMaterial_property_emission_color_texture:
  403. - :ref:`Texture<class_Texture>` **emission_color_texture**
  404. +----------+-----------------------------------+
  405. | *Setter* | set_emission_color_texture(value) |
  406. +----------+-----------------------------------+
  407. | *Getter* | get_emission_color_texture() |
  408. +----------+-----------------------------------+
  409. Particle color will be modulated by color determined by sampling this texture at the same point as the :ref:`emission_point_texture<class_ParticlesMaterial_property_emission_point_texture>`.
  410. ----
  411. .. _class_ParticlesMaterial_property_emission_normal_texture:
  412. - :ref:`Texture<class_Texture>` **emission_normal_texture**
  413. +----------+------------------------------------+
  414. | *Setter* | set_emission_normal_texture(value) |
  415. +----------+------------------------------------+
  416. | *Getter* | get_emission_normal_texture() |
  417. +----------+------------------------------------+
  418. Particle velocity and rotation will be set by sampling this texture at the same point as the :ref:`emission_point_texture<class_ParticlesMaterial_property_emission_point_texture>`. Used only in :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_ParticlesMaterial_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.
  419. ----
  420. .. _class_ParticlesMaterial_property_emission_point_count:
  421. - :ref:`int<class_int>` **emission_point_count**
  422. +----------+---------------------------------+
  423. | *Setter* | set_emission_point_count(value) |
  424. +----------+---------------------------------+
  425. | *Getter* | get_emission_point_count() |
  426. +----------+---------------------------------+
  427. The number of emission points if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_POINTS<class_ParticlesMaterial_constant_EMISSION_SHAPE_POINTS>` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_ParticlesMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS>`.
  428. ----
  429. .. _class_ParticlesMaterial_property_emission_point_texture:
  430. - :ref:`Texture<class_Texture>` **emission_point_texture**
  431. +----------+-----------------------------------+
  432. | *Setter* | set_emission_point_texture(value) |
  433. +----------+-----------------------------------+
  434. | *Getter* | get_emission_point_texture() |
  435. +----------+-----------------------------------+
  436. Particles will be emitted at positions determined by sampling this texture at a random position. Used with :ref:`EMISSION_SHAPE_POINTS<class_ParticlesMaterial_constant_EMISSION_SHAPE_POINTS>` and :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_ParticlesMaterial_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.
  437. ----
  438. .. _class_ParticlesMaterial_property_emission_shape:
  439. - :ref:`EmissionShape<enum_ParticlesMaterial_EmissionShape>` **emission_shape**
  440. +-----------+---------------------------+
  441. | *Default* | ``0`` |
  442. +-----------+---------------------------+
  443. | *Setter* | set_emission_shape(value) |
  444. +-----------+---------------------------+
  445. | *Getter* | get_emission_shape() |
  446. +-----------+---------------------------+
  447. Particles will be emitted inside this region. Use :ref:`EmissionShape<enum_ParticlesMaterial_EmissionShape>` constants for values.
  448. ----
  449. .. _class_ParticlesMaterial_property_emission_sphere_radius:
  450. - :ref:`float<class_float>` **emission_sphere_radius**
  451. +----------+-----------------------------------+
  452. | *Setter* | set_emission_sphere_radius(value) |
  453. +----------+-----------------------------------+
  454. | *Getter* | get_emission_sphere_radius() |
  455. +----------+-----------------------------------+
  456. The sphere's radius if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_SPHERE<class_ParticlesMaterial_constant_EMISSION_SHAPE_SPHERE>`.
  457. ----
  458. .. _class_ParticlesMaterial_property_flag_align_y:
  459. - :ref:`bool<class_bool>` **flag_align_y**
  460. +-----------+-----------------+
  461. | *Default* | ``false`` |
  462. +-----------+-----------------+
  463. | *Setter* | set_flag(value) |
  464. +-----------+-----------------+
  465. | *Getter* | get_flag() |
  466. +-----------+-----------------+
  467. Align Y axis of particle with the direction of its velocity.
  468. ----
  469. .. _class_ParticlesMaterial_property_flag_disable_z:
  470. - :ref:`bool<class_bool>` **flag_disable_z**
  471. +-----------+-----------------+
  472. | *Default* | ``false`` |
  473. +-----------+-----------------+
  474. | *Setter* | set_flag(value) |
  475. +-----------+-----------------+
  476. | *Getter* | get_flag() |
  477. +-----------+-----------------+
  478. If ``true``, particles will not move on the z axis.
  479. ----
  480. .. _class_ParticlesMaterial_property_flag_rotate_y:
  481. - :ref:`bool<class_bool>` **flag_rotate_y**
  482. +-----------+-----------------+
  483. | *Default* | ``false`` |
  484. +-----------+-----------------+
  485. | *Setter* | set_flag(value) |
  486. +-----------+-----------------+
  487. | *Getter* | get_flag() |
  488. +-----------+-----------------+
  489. If ``true``, particles rotate around Y axis by :ref:`angle<class_ParticlesMaterial_property_angle>`.
  490. ----
  491. .. _class_ParticlesMaterial_property_flatness:
  492. - :ref:`float<class_float>` **flatness**
  493. +-----------+---------------------+
  494. | *Default* | ``0.0`` |
  495. +-----------+---------------------+
  496. | *Setter* | set_flatness(value) |
  497. +-----------+---------------------+
  498. | *Getter* | get_flatness() |
  499. +-----------+---------------------+
  500. Amount of :ref:`spread<class_ParticlesMaterial_property_spread>` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane.
  501. ----
  502. .. _class_ParticlesMaterial_property_gravity:
  503. - :ref:`Vector3<class_Vector3>` **gravity**
  504. +-----------+---------------------------+
  505. | *Default* | ``Vector3( 0, -9.8, 0 )`` |
  506. +-----------+---------------------------+
  507. | *Setter* | set_gravity(value) |
  508. +-----------+---------------------------+
  509. | *Getter* | get_gravity() |
  510. +-----------+---------------------------+
  511. Gravity applied to every particle.
  512. ----
  513. .. _class_ParticlesMaterial_property_hue_variation:
  514. - :ref:`float<class_float>` **hue_variation**
  515. +-----------+------------------+
  516. | *Default* | ``0.0`` |
  517. +-----------+------------------+
  518. | *Setter* | set_param(value) |
  519. +-----------+------------------+
  520. | *Getter* | get_param() |
  521. +-----------+------------------+
  522. Initial hue variation applied to each particle.
  523. ----
  524. .. _class_ParticlesMaterial_property_hue_variation_curve:
  525. - :ref:`Texture<class_Texture>` **hue_variation_curve**
  526. +----------+--------------------------+
  527. | *Setter* | set_param_texture(value) |
  528. +----------+--------------------------+
  529. | *Getter* | get_param_texture() |
  530. +----------+--------------------------+
  531. Each particle's hue will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  532. ----
  533. .. _class_ParticlesMaterial_property_hue_variation_random:
  534. - :ref:`float<class_float>` **hue_variation_random**
  535. +-----------+-----------------------------+
  536. | *Default* | ``0.0`` |
  537. +-----------+-----------------------------+
  538. | *Setter* | set_param_randomness(value) |
  539. +-----------+-----------------------------+
  540. | *Getter* | get_param_randomness() |
  541. +-----------+-----------------------------+
  542. Hue variation randomness ratio.
  543. ----
  544. .. _class_ParticlesMaterial_property_initial_velocity:
  545. - :ref:`float<class_float>` **initial_velocity**
  546. +-----------+------------------+
  547. | *Default* | ``0.0`` |
  548. +-----------+------------------+
  549. | *Setter* | set_param(value) |
  550. +-----------+------------------+
  551. | *Getter* | get_param() |
  552. +-----------+------------------+
  553. Initial velocity magnitude for each particle. Direction comes from :ref:`spread<class_ParticlesMaterial_property_spread>` and the node's orientation.
  554. ----
  555. .. _class_ParticlesMaterial_property_initial_velocity_random:
  556. - :ref:`float<class_float>` **initial_velocity_random**
  557. +-----------+-----------------------------+
  558. | *Default* | ``0.0`` |
  559. +-----------+-----------------------------+
  560. | *Setter* | set_param_randomness(value) |
  561. +-----------+-----------------------------+
  562. | *Getter* | get_param_randomness() |
  563. +-----------+-----------------------------+
  564. Initial velocity randomness ratio.
  565. ----
  566. .. _class_ParticlesMaterial_property_lifetime_randomness:
  567. - :ref:`float<class_float>` **lifetime_randomness**
  568. +-----------+--------------------------------+
  569. | *Default* | ``0.0`` |
  570. +-----------+--------------------------------+
  571. | *Setter* | set_lifetime_randomness(value) |
  572. +-----------+--------------------------------+
  573. | *Getter* | get_lifetime_randomness() |
  574. +-----------+--------------------------------+
  575. Particle lifetime randomness ratio.
  576. ----
  577. .. _class_ParticlesMaterial_property_linear_accel:
  578. - :ref:`float<class_float>` **linear_accel**
  579. +-----------+------------------+
  580. | *Default* | ``0.0`` |
  581. +-----------+------------------+
  582. | *Setter* | set_param(value) |
  583. +-----------+------------------+
  584. | *Getter* | get_param() |
  585. +-----------+------------------+
  586. Linear acceleration applied to each particle in the direction of motion.
  587. ----
  588. .. _class_ParticlesMaterial_property_linear_accel_curve:
  589. - :ref:`Texture<class_Texture>` **linear_accel_curve**
  590. +----------+--------------------------+
  591. | *Setter* | set_param_texture(value) |
  592. +----------+--------------------------+
  593. | *Getter* | get_param_texture() |
  594. +----------+--------------------------+
  595. Each particle's linear acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  596. ----
  597. .. _class_ParticlesMaterial_property_linear_accel_random:
  598. - :ref:`float<class_float>` **linear_accel_random**
  599. +-----------+-----------------------------+
  600. | *Default* | ``0.0`` |
  601. +-----------+-----------------------------+
  602. | *Setter* | set_param_randomness(value) |
  603. +-----------+-----------------------------+
  604. | *Getter* | get_param_randomness() |
  605. +-----------+-----------------------------+
  606. Linear acceleration randomness ratio.
  607. ----
  608. .. _class_ParticlesMaterial_property_orbit_velocity:
  609. - :ref:`float<class_float>` **orbit_velocity**
  610. +----------+------------------+
  611. | *Setter* | set_param(value) |
  612. +----------+------------------+
  613. | *Getter* | get_param() |
  614. +----------+------------------+
  615. Orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second.
  616. Only available when :ref:`flag_disable_z<class_ParticlesMaterial_property_flag_disable_z>` is ``true``.
  617. ----
  618. .. _class_ParticlesMaterial_property_orbit_velocity_curve:
  619. - :ref:`Texture<class_Texture>` **orbit_velocity_curve**
  620. +----------+--------------------------+
  621. | *Setter* | set_param_texture(value) |
  622. +----------+--------------------------+
  623. | *Getter* | get_param_texture() |
  624. +----------+--------------------------+
  625. Each particle's orbital velocity will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  626. ----
  627. .. _class_ParticlesMaterial_property_orbit_velocity_random:
  628. - :ref:`float<class_float>` **orbit_velocity_random**
  629. +----------+-----------------------------+
  630. | *Setter* | set_param_randomness(value) |
  631. +----------+-----------------------------+
  632. | *Getter* | get_param_randomness() |
  633. +----------+-----------------------------+
  634. Orbital velocity randomness ratio.
  635. ----
  636. .. _class_ParticlesMaterial_property_radial_accel:
  637. - :ref:`float<class_float>` **radial_accel**
  638. +-----------+------------------+
  639. | *Default* | ``0.0`` |
  640. +-----------+------------------+
  641. | *Setter* | set_param(value) |
  642. +-----------+------------------+
  643. | *Getter* | get_param() |
  644. +-----------+------------------+
  645. Radial acceleration applied to each particle. Makes particle accelerate away from origin.
  646. ----
  647. .. _class_ParticlesMaterial_property_radial_accel_curve:
  648. - :ref:`Texture<class_Texture>` **radial_accel_curve**
  649. +----------+--------------------------+
  650. | *Setter* | set_param_texture(value) |
  651. +----------+--------------------------+
  652. | *Getter* | get_param_texture() |
  653. +----------+--------------------------+
  654. Each particle's radial acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  655. ----
  656. .. _class_ParticlesMaterial_property_radial_accel_random:
  657. - :ref:`float<class_float>` **radial_accel_random**
  658. +-----------+-----------------------------+
  659. | *Default* | ``0.0`` |
  660. +-----------+-----------------------------+
  661. | *Setter* | set_param_randomness(value) |
  662. +-----------+-----------------------------+
  663. | *Getter* | get_param_randomness() |
  664. +-----------+-----------------------------+
  665. Radial acceleration randomness ratio.
  666. ----
  667. .. _class_ParticlesMaterial_property_scale:
  668. - :ref:`float<class_float>` **scale**
  669. +-----------+------------------+
  670. | *Default* | ``1.0`` |
  671. +-----------+------------------+
  672. | *Setter* | set_param(value) |
  673. +-----------+------------------+
  674. | *Getter* | get_param() |
  675. +-----------+------------------+
  676. Initial scale applied to each particle.
  677. ----
  678. .. _class_ParticlesMaterial_property_scale_curve:
  679. - :ref:`Texture<class_Texture>` **scale_curve**
  680. +----------+--------------------------+
  681. | *Setter* | set_param_texture(value) |
  682. +----------+--------------------------+
  683. | *Getter* | get_param_texture() |
  684. +----------+--------------------------+
  685. Each particle's scale will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  686. ----
  687. .. _class_ParticlesMaterial_property_scale_random:
  688. - :ref:`float<class_float>` **scale_random**
  689. +-----------+-----------------------------+
  690. | *Default* | ``0.0`` |
  691. +-----------+-----------------------------+
  692. | *Setter* | set_param_randomness(value) |
  693. +-----------+-----------------------------+
  694. | *Getter* | get_param_randomness() |
  695. +-----------+-----------------------------+
  696. Scale randomness ratio.
  697. ----
  698. .. _class_ParticlesMaterial_property_spread:
  699. - :ref:`float<class_float>` **spread**
  700. +-----------+-------------------+
  701. | *Default* | ``45.0`` |
  702. +-----------+-------------------+
  703. | *Setter* | set_spread(value) |
  704. +-----------+-------------------+
  705. | *Getter* | get_spread() |
  706. +-----------+-------------------+
  707. Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Applied to X/Z plane and Y/Z planes.
  708. ----
  709. .. _class_ParticlesMaterial_property_tangential_accel:
  710. - :ref:`float<class_float>` **tangential_accel**
  711. +-----------+------------------+
  712. | *Default* | ``0.0`` |
  713. +-----------+------------------+
  714. | *Setter* | set_param(value) |
  715. +-----------+------------------+
  716. | *Getter* | get_param() |
  717. +-----------+------------------+
  718. Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
  719. ----
  720. .. _class_ParticlesMaterial_property_tangential_accel_curve:
  721. - :ref:`Texture<class_Texture>` **tangential_accel_curve**
  722. +----------+--------------------------+
  723. | *Setter* | set_param_texture(value) |
  724. +----------+--------------------------+
  725. | *Getter* | get_param_texture() |
  726. +----------+--------------------------+
  727. Each particle's tangential acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  728. ----
  729. .. _class_ParticlesMaterial_property_tangential_accel_random:
  730. - :ref:`float<class_float>` **tangential_accel_random**
  731. +-----------+-----------------------------+
  732. | *Default* | ``0.0`` |
  733. +-----------+-----------------------------+
  734. | *Setter* | set_param_randomness(value) |
  735. +-----------+-----------------------------+
  736. | *Getter* | get_param_randomness() |
  737. +-----------+-----------------------------+
  738. Tangential acceleration randomness ratio.
  739. ----
  740. .. _class_ParticlesMaterial_property_trail_color_modifier:
  741. - :ref:`GradientTexture<class_GradientTexture>` **trail_color_modifier**
  742. +----------+---------------------------------+
  743. | *Setter* | set_trail_color_modifier(value) |
  744. +----------+---------------------------------+
  745. | *Getter* | get_trail_color_modifier() |
  746. +----------+---------------------------------+
  747. Trail particles' color will vary along this :ref:`GradientTexture<class_GradientTexture>`.
  748. ----
  749. .. _class_ParticlesMaterial_property_trail_divisor:
  750. - :ref:`int<class_int>` **trail_divisor**
  751. +-----------+--------------------------+
  752. | *Default* | ``1`` |
  753. +-----------+--------------------------+
  754. | *Setter* | set_trail_divisor(value) |
  755. +-----------+--------------------------+
  756. | *Getter* | get_trail_divisor() |
  757. +-----------+--------------------------+
  758. Emitter will emit ``amount`` divided by ``trail_divisor`` particles. The remaining particles will be used as trail(s).
  759. ----
  760. .. _class_ParticlesMaterial_property_trail_size_modifier:
  761. - :ref:`CurveTexture<class_CurveTexture>` **trail_size_modifier**
  762. +----------+--------------------------------+
  763. | *Setter* | set_trail_size_modifier(value) |
  764. +----------+--------------------------------+
  765. | *Getter* | get_trail_size_modifier() |
  766. +----------+--------------------------------+
  767. Trail particles' size will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  768. Method Descriptions
  769. -------------------
  770. .. _class_ParticlesMaterial_method_get_flag:
  771. - :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_ParticlesMaterial_Flags>` flag **)** |const|
  772. Returns ``true`` if the specified flag is enabled.
  773. ----
  774. .. _class_ParticlesMaterial_method_get_param:
  775. - :ref:`float<class_float>` **get_param** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** |const|
  776. Returns the value of the specified parameter.
  777. ----
  778. .. _class_ParticlesMaterial_method_get_param_randomness:
  779. - :ref:`float<class_float>` **get_param_randomness** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** |const|
  780. Returns the randomness ratio associated with the specified parameter.
  781. ----
  782. .. _class_ParticlesMaterial_method_get_param_texture:
  783. - :ref:`Texture<class_Texture>` **get_param_texture** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** |const|
  784. Returns the :ref:`Texture<class_Texture>` used by the specified parameter.
  785. ----
  786. .. _class_ParticlesMaterial_method_set_flag:
  787. - void **set_flag** **(** :ref:`Flags<enum_ParticlesMaterial_Flags>` flag, :ref:`bool<class_bool>` enable **)**
  788. If ``true``, enables the specified flag. See :ref:`Flags<enum_ParticlesMaterial_Flags>` for options.
  789. ----
  790. .. _class_ParticlesMaterial_method_set_param:
  791. - void **set_param** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
  792. Sets the specified :ref:`Parameter<enum_ParticlesMaterial_Parameter>`.
  793. ----
  794. .. _class_ParticlesMaterial_method_set_param_randomness:
  795. - void **set_param_randomness** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`float<class_float>` randomness **)**
  796. Sets the randomness ratio for the specified :ref:`Parameter<enum_ParticlesMaterial_Parameter>`.
  797. ----
  798. .. _class_ParticlesMaterial_method_set_param_texture:
  799. - void **set_param_texture** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`Texture<class_Texture>` texture **)**
  800. Sets the :ref:`Texture<class_Texture>` for the specified :ref:`Parameter<enum_ParticlesMaterial_Parameter>`.
  801. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  802. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  803. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`