class_particlesmaterial.rst 58 KB

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