class_cpuparticles.rst 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the CPUParticles.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_CPUParticles:
  5. CPUParticles
  6. ============
  7. **Inherits:** :ref:`GeometryInstance<class_GeometryInstance>` **<** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Properties
  12. ----------
  13. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  14. | :ref:`int<class_int>` | :ref:`amount<class_CPUParticles_property_amount>` |
  15. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`angle<class_CPUParticles_property_angle>` |
  17. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  18. | :ref:`Curve<class_Curve>` | :ref:`angle_curve<class_CPUParticles_property_angle_curve>` |
  19. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`angle_random<class_CPUParticles_property_angle_random>` |
  21. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  22. | :ref:`float<class_float>` | :ref:`angular_velocity<class_CPUParticles_property_angular_velocity>` |
  23. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  24. | :ref:`Curve<class_Curve>` | :ref:`angular_velocity_curve<class_CPUParticles_property_angular_velocity_curve>` |
  25. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  26. | :ref:`float<class_float>` | :ref:`angular_velocity_random<class_CPUParticles_property_angular_velocity_random>` |
  27. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  28. | :ref:`float<class_float>` | :ref:`anim_offset<class_CPUParticles_property_anim_offset>` |
  29. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  30. | :ref:`Curve<class_Curve>` | :ref:`anim_offset_curve<class_CPUParticles_property_anim_offset_curve>` |
  31. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  32. | :ref:`float<class_float>` | :ref:`anim_offset_random<class_CPUParticles_property_anim_offset_random>` |
  33. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  34. | :ref:`float<class_float>` | :ref:`anim_speed<class_CPUParticles_property_anim_speed>` |
  35. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  36. | :ref:`Curve<class_Curve>` | :ref:`anim_speed_curve<class_CPUParticles_property_anim_speed_curve>` |
  37. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  38. | :ref:`float<class_float>` | :ref:`anim_speed_random<class_CPUParticles_property_anim_speed_random>` |
  39. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  40. | :ref:`Color<class_Color>` | :ref:`color<class_CPUParticles_property_color>` |
  41. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  42. | :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_CPUParticles_property_color_ramp>` |
  43. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  44. | :ref:`float<class_float>` | :ref:`damping<class_CPUParticles_property_damping>` |
  45. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  46. | :ref:`Curve<class_Curve>` | :ref:`damping_curve<class_CPUParticles_property_damping_curve>` |
  47. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  48. | :ref:`float<class_float>` | :ref:`damping_random<class_CPUParticles_property_damping_random>` |
  49. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  50. | :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` | :ref:`draw_order<class_CPUParticles_property_draw_order>` |
  51. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  52. | :ref:`Vector3<class_Vector3>` | :ref:`emission_box_extents<class_CPUParticles_property_emission_box_extents>` |
  53. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  54. | :ref:`PoolColorArray<class_PoolColorArray>` | :ref:`emission_colors<class_CPUParticles_property_emission_colors>` |
  55. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  56. | :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`emission_normals<class_CPUParticles_property_emission_normals>` |
  57. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  58. | :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`emission_points<class_CPUParticles_property_emission_points>` |
  59. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  60. | :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` | :ref:`emission_shape<class_CPUParticles_property_emission_shape>` |
  61. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  62. | :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_CPUParticles_property_emission_sphere_radius>` |
  63. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  64. | :ref:`bool<class_bool>` | :ref:`emitting<class_CPUParticles_property_emitting>` |
  65. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  66. | :ref:`float<class_float>` | :ref:`explosiveness<class_CPUParticles_property_explosiveness>` |
  67. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  68. | :ref:`int<class_int>` | :ref:`fixed_fps<class_CPUParticles_property_fixed_fps>` |
  69. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  70. | :ref:`bool<class_bool>` | :ref:`flag_align_y<class_CPUParticles_property_flag_align_y>` |
  71. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  72. | :ref:`bool<class_bool>` | :ref:`flag_disable_z<class_CPUParticles_property_flag_disable_z>` |
  73. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  74. | :ref:`bool<class_bool>` | :ref:`flag_rotate_y<class_CPUParticles_property_flag_rotate_y>` |
  75. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  76. | :ref:`float<class_float>` | :ref:`flatness<class_CPUParticles_property_flatness>` |
  77. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  78. | :ref:`bool<class_bool>` | :ref:`fract_delta<class_CPUParticles_property_fract_delta>` |
  79. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  80. | :ref:`Vector3<class_Vector3>` | :ref:`gravity<class_CPUParticles_property_gravity>` |
  81. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  82. | :ref:`float<class_float>` | :ref:`hue_variation<class_CPUParticles_property_hue_variation>` |
  83. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  84. | :ref:`Curve<class_Curve>` | :ref:`hue_variation_curve<class_CPUParticles_property_hue_variation_curve>` |
  85. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  86. | :ref:`float<class_float>` | :ref:`hue_variation_random<class_CPUParticles_property_hue_variation_random>` |
  87. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  88. | :ref:`float<class_float>` | :ref:`initial_velocity<class_CPUParticles_property_initial_velocity>` |
  89. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  90. | :ref:`float<class_float>` | :ref:`initial_velocity_random<class_CPUParticles_property_initial_velocity_random>` |
  91. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  92. | :ref:`float<class_float>` | :ref:`lifetime<class_CPUParticles_property_lifetime>` |
  93. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  94. | :ref:`float<class_float>` | :ref:`linear_accel<class_CPUParticles_property_linear_accel>` |
  95. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  96. | :ref:`Curve<class_Curve>` | :ref:`linear_accel_curve<class_CPUParticles_property_linear_accel_curve>` |
  97. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  98. | :ref:`float<class_float>` | :ref:`linear_accel_random<class_CPUParticles_property_linear_accel_random>` |
  99. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  100. | :ref:`bool<class_bool>` | :ref:`local_coords<class_CPUParticles_property_local_coords>` |
  101. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  102. | :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CPUParticles_property_mesh>` |
  103. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  104. | :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles_property_one_shot>` |
  105. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  106. | :ref:`float<class_float>` | :ref:`preprocess<class_CPUParticles_property_preprocess>` |
  107. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  108. | :ref:`float<class_float>` | :ref:`radial_accel<class_CPUParticles_property_radial_accel>` |
  109. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  110. | :ref:`Curve<class_Curve>` | :ref:`radial_accel_curve<class_CPUParticles_property_radial_accel_curve>` |
  111. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  112. | :ref:`float<class_float>` | :ref:`radial_accel_random<class_CPUParticles_property_radial_accel_random>` |
  113. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  114. | :ref:`float<class_float>` | :ref:`randomness<class_CPUParticles_property_randomness>` |
  115. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  116. | :ref:`float<class_float>` | :ref:`scale_amount<class_CPUParticles_property_scale_amount>` |
  117. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  118. | :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles_property_scale_amount_curve>` |
  119. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  120. | :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles_property_scale_amount_random>` |
  121. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  122. | :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles_property_speed_scale>` |
  123. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  124. | :ref:`float<class_float>` | :ref:`spread<class_CPUParticles_property_spread>` |
  125. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  126. | :ref:`float<class_float>` | :ref:`tangential_accel<class_CPUParticles_property_tangential_accel>` |
  127. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  128. | :ref:`Curve<class_Curve>` | :ref:`tangential_accel_curve<class_CPUParticles_property_tangential_accel_curve>` |
  129. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  130. | :ref:`float<class_float>` | :ref:`tangential_accel_random<class_CPUParticles_property_tangential_accel_random>` |
  131. +-------------------------------------------------------+-------------------------------------------------------------------------------------+
  132. Methods
  133. -------
  134. +------+-------------------------------------------------------------------------------------------------------------------------------+
  135. | void | :ref:`convert_from_particles<class_CPUParticles_method_convert_from_particles>` **(** :ref:`Node<class_Node>` particles **)** |
  136. +------+-------------------------------------------------------------------------------------------------------------------------------+
  137. | void | :ref:`restart<class_CPUParticles_method_restart>` **(** **)** |
  138. +------+-------------------------------------------------------------------------------------------------------------------------------+
  139. Enumerations
  140. ------------
  141. .. _enum_CPUParticles_DrawOrder:
  142. .. _class_CPUParticles_constant_DRAW_ORDER_INDEX:
  143. .. _class_CPUParticles_constant_DRAW_ORDER_LIFETIME:
  144. .. _class_CPUParticles_constant_DRAW_ORDER_VIEW_DEPTH:
  145. enum **DrawOrder**:
  146. - **DRAW_ORDER_INDEX** = **0**
  147. - **DRAW_ORDER_LIFETIME** = **1**
  148. - **DRAW_ORDER_VIEW_DEPTH** = **2**
  149. .. _enum_CPUParticles_Parameter:
  150. .. _class_CPUParticles_constant_PARAM_INITIAL_LINEAR_VELOCITY:
  151. .. _class_CPUParticles_constant_PARAM_ANGULAR_VELOCITY:
  152. .. _class_CPUParticles_constant_PARAM_LINEAR_ACCEL:
  153. .. _class_CPUParticles_constant_PARAM_RADIAL_ACCEL:
  154. .. _class_CPUParticles_constant_PARAM_TANGENTIAL_ACCEL:
  155. .. _class_CPUParticles_constant_PARAM_DAMPING:
  156. .. _class_CPUParticles_constant_PARAM_ANGLE:
  157. .. _class_CPUParticles_constant_PARAM_SCALE:
  158. .. _class_CPUParticles_constant_PARAM_HUE_VARIATION:
  159. .. _class_CPUParticles_constant_PARAM_ANIM_SPEED:
  160. .. _class_CPUParticles_constant_PARAM_ANIM_OFFSET:
  161. .. _class_CPUParticles_constant_PARAM_MAX:
  162. enum **Parameter**:
  163. - **PARAM_INITIAL_LINEAR_VELOCITY** = **0**
  164. - **PARAM_ANGULAR_VELOCITY** = **1**
  165. - **PARAM_LINEAR_ACCEL** = **2**
  166. - **PARAM_RADIAL_ACCEL** = **3**
  167. - **PARAM_TANGENTIAL_ACCEL** = **4**
  168. - **PARAM_DAMPING** = **5**
  169. - **PARAM_ANGLE** = **6**
  170. - **PARAM_SCALE** = **7**
  171. - **PARAM_HUE_VARIATION** = **8**
  172. - **PARAM_ANIM_SPEED** = **9**
  173. - **PARAM_ANIM_OFFSET** = **10**
  174. - **PARAM_MAX** = **11**
  175. .. _enum_CPUParticles_Flags:
  176. .. _class_CPUParticles_constant_FLAG_ALIGN_Y_TO_VELOCITY:
  177. .. _class_CPUParticles_constant_FLAG_ROTATE_Y:
  178. .. _class_CPUParticles_constant_FLAG_MAX:
  179. enum **Flags**:
  180. - **FLAG_ALIGN_Y_TO_VELOCITY** = **0**
  181. - **FLAG_ROTATE_Y** = **1**
  182. - **FLAG_MAX** = **3**
  183. .. _enum_CPUParticles_EmissionShape:
  184. .. _class_CPUParticles_constant_EMISSION_SHAPE_POINT:
  185. .. _class_CPUParticles_constant_EMISSION_SHAPE_SPHERE:
  186. .. _class_CPUParticles_constant_EMISSION_SHAPE_BOX:
  187. .. _class_CPUParticles_constant_EMISSION_SHAPE_POINTS:
  188. .. _class_CPUParticles_constant_EMISSION_SHAPE_DIRECTED_POINTS:
  189. enum **EmissionShape**:
  190. - **EMISSION_SHAPE_POINT** = **0**
  191. - **EMISSION_SHAPE_SPHERE** = **1**
  192. - **EMISSION_SHAPE_BOX** = **2**
  193. - **EMISSION_SHAPE_POINTS** = **3**
  194. - **EMISSION_SHAPE_DIRECTED_POINTS** = **4**
  195. Property Descriptions
  196. ---------------------
  197. .. _class_CPUParticles_property_amount:
  198. - :ref:`int<class_int>` **amount**
  199. +----------+-------------------+
  200. | *Setter* | set_amount(value) |
  201. +----------+-------------------+
  202. | *Getter* | get_amount() |
  203. +----------+-------------------+
  204. .. _class_CPUParticles_property_angle:
  205. - :ref:`float<class_float>` **angle**
  206. +----------+------------------+
  207. | *Setter* | set_param(value) |
  208. +----------+------------------+
  209. | *Getter* | get_param() |
  210. +----------+------------------+
  211. .. _class_CPUParticles_property_angle_curve:
  212. - :ref:`Curve<class_Curve>` **angle_curve**
  213. +----------+------------------------+
  214. | *Setter* | set_param_curve(value) |
  215. +----------+------------------------+
  216. | *Getter* | get_param_curve() |
  217. +----------+------------------------+
  218. .. _class_CPUParticles_property_angle_random:
  219. - :ref:`float<class_float>` **angle_random**
  220. +----------+-----------------------------+
  221. | *Setter* | set_param_randomness(value) |
  222. +----------+-----------------------------+
  223. | *Getter* | get_param_randomness() |
  224. +----------+-----------------------------+
  225. .. _class_CPUParticles_property_angular_velocity:
  226. - :ref:`float<class_float>` **angular_velocity**
  227. +----------+------------------+
  228. | *Setter* | set_param(value) |
  229. +----------+------------------+
  230. | *Getter* | get_param() |
  231. +----------+------------------+
  232. .. _class_CPUParticles_property_angular_velocity_curve:
  233. - :ref:`Curve<class_Curve>` **angular_velocity_curve**
  234. +----------+------------------------+
  235. | *Setter* | set_param_curve(value) |
  236. +----------+------------------------+
  237. | *Getter* | get_param_curve() |
  238. +----------+------------------------+
  239. .. _class_CPUParticles_property_angular_velocity_random:
  240. - :ref:`float<class_float>` **angular_velocity_random**
  241. +----------+-----------------------------+
  242. | *Setter* | set_param_randomness(value) |
  243. +----------+-----------------------------+
  244. | *Getter* | get_param_randomness() |
  245. +----------+-----------------------------+
  246. .. _class_CPUParticles_property_anim_offset:
  247. - :ref:`float<class_float>` **anim_offset**
  248. +----------+------------------+
  249. | *Setter* | set_param(value) |
  250. +----------+------------------+
  251. | *Getter* | get_param() |
  252. +----------+------------------+
  253. .. _class_CPUParticles_property_anim_offset_curve:
  254. - :ref:`Curve<class_Curve>` **anim_offset_curve**
  255. +----------+------------------------+
  256. | *Setter* | set_param_curve(value) |
  257. +----------+------------------------+
  258. | *Getter* | get_param_curve() |
  259. +----------+------------------------+
  260. .. _class_CPUParticles_property_anim_offset_random:
  261. - :ref:`float<class_float>` **anim_offset_random**
  262. +----------+-----------------------------+
  263. | *Setter* | set_param_randomness(value) |
  264. +----------+-----------------------------+
  265. | *Getter* | get_param_randomness() |
  266. +----------+-----------------------------+
  267. .. _class_CPUParticles_property_anim_speed:
  268. - :ref:`float<class_float>` **anim_speed**
  269. +----------+------------------+
  270. | *Setter* | set_param(value) |
  271. +----------+------------------+
  272. | *Getter* | get_param() |
  273. +----------+------------------+
  274. .. _class_CPUParticles_property_anim_speed_curve:
  275. - :ref:`Curve<class_Curve>` **anim_speed_curve**
  276. +----------+------------------------+
  277. | *Setter* | set_param_curve(value) |
  278. +----------+------------------------+
  279. | *Getter* | get_param_curve() |
  280. +----------+------------------------+
  281. .. _class_CPUParticles_property_anim_speed_random:
  282. - :ref:`float<class_float>` **anim_speed_random**
  283. +----------+-----------------------------+
  284. | *Setter* | set_param_randomness(value) |
  285. +----------+-----------------------------+
  286. | *Getter* | get_param_randomness() |
  287. +----------+-----------------------------+
  288. .. _class_CPUParticles_property_color:
  289. - :ref:`Color<class_Color>` **color**
  290. +----------+------------------+
  291. | *Setter* | set_color(value) |
  292. +----------+------------------+
  293. | *Getter* | get_color() |
  294. +----------+------------------+
  295. .. _class_CPUParticles_property_color_ramp:
  296. - :ref:`Gradient<class_Gradient>` **color_ramp**
  297. +----------+-----------------------+
  298. | *Setter* | set_color_ramp(value) |
  299. +----------+-----------------------+
  300. | *Getter* | get_color_ramp() |
  301. +----------+-----------------------+
  302. Each particle's vertex color will vary along this :ref:`GradientTexture<class_GradientTexture>`.
  303. .. _class_CPUParticles_property_damping:
  304. - :ref:`float<class_float>` **damping**
  305. +----------+------------------+
  306. | *Setter* | set_param(value) |
  307. +----------+------------------+
  308. | *Getter* | get_param() |
  309. +----------+------------------+
  310. .. _class_CPUParticles_property_damping_curve:
  311. - :ref:`Curve<class_Curve>` **damping_curve**
  312. +----------+------------------------+
  313. | *Setter* | set_param_curve(value) |
  314. +----------+------------------------+
  315. | *Getter* | get_param_curve() |
  316. +----------+------------------------+
  317. .. _class_CPUParticles_property_damping_random:
  318. - :ref:`float<class_float>` **damping_random**
  319. +----------+-----------------------------+
  320. | *Setter* | set_param_randomness(value) |
  321. +----------+-----------------------------+
  322. | *Getter* | get_param_randomness() |
  323. +----------+-----------------------------+
  324. .. _class_CPUParticles_property_draw_order:
  325. - :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` **draw_order**
  326. +----------+-----------------------+
  327. | *Setter* | set_draw_order(value) |
  328. +----------+-----------------------+
  329. | *Getter* | get_draw_order() |
  330. +----------+-----------------------+
  331. .. _class_CPUParticles_property_emission_box_extents:
  332. - :ref:`Vector3<class_Vector3>` **emission_box_extents**
  333. +----------+---------------------------------+
  334. | *Setter* | set_emission_box_extents(value) |
  335. +----------+---------------------------------+
  336. | *Getter* | get_emission_box_extents() |
  337. +----------+---------------------------------+
  338. .. _class_CPUParticles_property_emission_colors:
  339. - :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors**
  340. +----------+----------------------------+
  341. | *Setter* | set_emission_colors(value) |
  342. +----------+----------------------------+
  343. | *Getter* | get_emission_colors() |
  344. +----------+----------------------------+
  345. .. _class_CPUParticles_property_emission_normals:
  346. - :ref:`PoolVector3Array<class_PoolVector3Array>` **emission_normals**
  347. +----------+-----------------------------+
  348. | *Setter* | set_emission_normals(value) |
  349. +----------+-----------------------------+
  350. | *Getter* | get_emission_normals() |
  351. +----------+-----------------------------+
  352. .. _class_CPUParticles_property_emission_points:
  353. - :ref:`PoolVector3Array<class_PoolVector3Array>` **emission_points**
  354. +----------+----------------------------+
  355. | *Setter* | set_emission_points(value) |
  356. +----------+----------------------------+
  357. | *Getter* | get_emission_points() |
  358. +----------+----------------------------+
  359. .. _class_CPUParticles_property_emission_shape:
  360. - :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` **emission_shape**
  361. +----------+---------------------------+
  362. | *Setter* | set_emission_shape(value) |
  363. +----------+---------------------------+
  364. | *Getter* | get_emission_shape() |
  365. +----------+---------------------------+
  366. .. _class_CPUParticles_property_emission_sphere_radius:
  367. - :ref:`float<class_float>` **emission_sphere_radius**
  368. +----------+-----------------------------------+
  369. | *Setter* | set_emission_sphere_radius(value) |
  370. +----------+-----------------------------------+
  371. | *Getter* | get_emission_sphere_radius() |
  372. +----------+-----------------------------------+
  373. .. _class_CPUParticles_property_emitting:
  374. - :ref:`bool<class_bool>` **emitting**
  375. +----------+---------------------+
  376. | *Setter* | set_emitting(value) |
  377. +----------+---------------------+
  378. | *Getter* | is_emitting() |
  379. +----------+---------------------+
  380. .. _class_CPUParticles_property_explosiveness:
  381. - :ref:`float<class_float>` **explosiveness**
  382. +----------+--------------------------------+
  383. | *Setter* | set_explosiveness_ratio(value) |
  384. +----------+--------------------------------+
  385. | *Getter* | get_explosiveness_ratio() |
  386. +----------+--------------------------------+
  387. .. _class_CPUParticles_property_fixed_fps:
  388. - :ref:`int<class_int>` **fixed_fps**
  389. +----------+----------------------+
  390. | *Setter* | set_fixed_fps(value) |
  391. +----------+----------------------+
  392. | *Getter* | get_fixed_fps() |
  393. +----------+----------------------+
  394. .. _class_CPUParticles_property_flag_align_y:
  395. - :ref:`bool<class_bool>` **flag_align_y**
  396. +----------+--------------------------+
  397. | *Setter* | set_particle_flag(value) |
  398. +----------+--------------------------+
  399. | *Getter* | get_particle_flag() |
  400. +----------+--------------------------+
  401. .. _class_CPUParticles_property_flag_disable_z:
  402. - :ref:`bool<class_bool>` **flag_disable_z**
  403. +----------+--------------------------+
  404. | *Setter* | set_particle_flag(value) |
  405. +----------+--------------------------+
  406. | *Getter* | get_particle_flag() |
  407. +----------+--------------------------+
  408. .. _class_CPUParticles_property_flag_rotate_y:
  409. - :ref:`bool<class_bool>` **flag_rotate_y**
  410. +----------+--------------------------+
  411. | *Setter* | set_particle_flag(value) |
  412. +----------+--------------------------+
  413. | *Getter* | get_particle_flag() |
  414. +----------+--------------------------+
  415. .. _class_CPUParticles_property_flatness:
  416. - :ref:`float<class_float>` **flatness**
  417. +----------+---------------------+
  418. | *Setter* | set_flatness(value) |
  419. +----------+---------------------+
  420. | *Getter* | get_flatness() |
  421. +----------+---------------------+
  422. .. _class_CPUParticles_property_fract_delta:
  423. - :ref:`bool<class_bool>` **fract_delta**
  424. +----------+-----------------------------+
  425. | *Setter* | set_fractional_delta(value) |
  426. +----------+-----------------------------+
  427. | *Getter* | get_fractional_delta() |
  428. +----------+-----------------------------+
  429. .. _class_CPUParticles_property_gravity:
  430. - :ref:`Vector3<class_Vector3>` **gravity**
  431. +----------+--------------------+
  432. | *Setter* | set_gravity(value) |
  433. +----------+--------------------+
  434. | *Getter* | get_gravity() |
  435. +----------+--------------------+
  436. .. _class_CPUParticles_property_hue_variation:
  437. - :ref:`float<class_float>` **hue_variation**
  438. +----------+------------------+
  439. | *Setter* | set_param(value) |
  440. +----------+------------------+
  441. | *Getter* | get_param() |
  442. +----------+------------------+
  443. .. _class_CPUParticles_property_hue_variation_curve:
  444. - :ref:`Curve<class_Curve>` **hue_variation_curve**
  445. +----------+------------------------+
  446. | *Setter* | set_param_curve(value) |
  447. +----------+------------------------+
  448. | *Getter* | get_param_curve() |
  449. +----------+------------------------+
  450. .. _class_CPUParticles_property_hue_variation_random:
  451. - :ref:`float<class_float>` **hue_variation_random**
  452. +----------+-----------------------------+
  453. | *Setter* | set_param_randomness(value) |
  454. +----------+-----------------------------+
  455. | *Getter* | get_param_randomness() |
  456. +----------+-----------------------------+
  457. .. _class_CPUParticles_property_initial_velocity:
  458. - :ref:`float<class_float>` **initial_velocity**
  459. +----------+------------------+
  460. | *Setter* | set_param(value) |
  461. +----------+------------------+
  462. | *Getter* | get_param() |
  463. +----------+------------------+
  464. .. _class_CPUParticles_property_initial_velocity_random:
  465. - :ref:`float<class_float>` **initial_velocity_random**
  466. +----------+-----------------------------+
  467. | *Setter* | set_param_randomness(value) |
  468. +----------+-----------------------------+
  469. | *Getter* | get_param_randomness() |
  470. +----------+-----------------------------+
  471. .. _class_CPUParticles_property_lifetime:
  472. - :ref:`float<class_float>` **lifetime**
  473. +----------+---------------------+
  474. | *Setter* | set_lifetime(value) |
  475. +----------+---------------------+
  476. | *Getter* | get_lifetime() |
  477. +----------+---------------------+
  478. .. _class_CPUParticles_property_linear_accel:
  479. - :ref:`float<class_float>` **linear_accel**
  480. +----------+------------------+
  481. | *Setter* | set_param(value) |
  482. +----------+------------------+
  483. | *Getter* | get_param() |
  484. +----------+------------------+
  485. .. _class_CPUParticles_property_linear_accel_curve:
  486. - :ref:`Curve<class_Curve>` **linear_accel_curve**
  487. +----------+------------------------+
  488. | *Setter* | set_param_curve(value) |
  489. +----------+------------------------+
  490. | *Getter* | get_param_curve() |
  491. +----------+------------------------+
  492. .. _class_CPUParticles_property_linear_accel_random:
  493. - :ref:`float<class_float>` **linear_accel_random**
  494. +----------+-----------------------------+
  495. | *Setter* | set_param_randomness(value) |
  496. +----------+-----------------------------+
  497. | *Getter* | get_param_randomness() |
  498. +----------+-----------------------------+
  499. .. _class_CPUParticles_property_local_coords:
  500. - :ref:`bool<class_bool>` **local_coords**
  501. +----------+----------------------------------+
  502. | *Setter* | set_use_local_coordinates(value) |
  503. +----------+----------------------------------+
  504. | *Getter* | get_use_local_coordinates() |
  505. +----------+----------------------------------+
  506. .. _class_CPUParticles_property_mesh:
  507. - :ref:`Mesh<class_Mesh>` **mesh**
  508. +----------+-----------------+
  509. | *Setter* | set_mesh(value) |
  510. +----------+-----------------+
  511. | *Getter* | get_mesh() |
  512. +----------+-----------------+
  513. .. _class_CPUParticles_property_one_shot:
  514. - :ref:`bool<class_bool>` **one_shot**
  515. +----------+---------------------+
  516. | *Setter* | set_one_shot(value) |
  517. +----------+---------------------+
  518. | *Getter* | get_one_shot() |
  519. +----------+---------------------+
  520. .. _class_CPUParticles_property_preprocess:
  521. - :ref:`float<class_float>` **preprocess**
  522. +----------+-----------------------------+
  523. | *Setter* | set_pre_process_time(value) |
  524. +----------+-----------------------------+
  525. | *Getter* | get_pre_process_time() |
  526. +----------+-----------------------------+
  527. .. _class_CPUParticles_property_radial_accel:
  528. - :ref:`float<class_float>` **radial_accel**
  529. +----------+------------------+
  530. | *Setter* | set_param(value) |
  531. +----------+------------------+
  532. | *Getter* | get_param() |
  533. +----------+------------------+
  534. .. _class_CPUParticles_property_radial_accel_curve:
  535. - :ref:`Curve<class_Curve>` **radial_accel_curve**
  536. +----------+------------------------+
  537. | *Setter* | set_param_curve(value) |
  538. +----------+------------------------+
  539. | *Getter* | get_param_curve() |
  540. +----------+------------------------+
  541. .. _class_CPUParticles_property_radial_accel_random:
  542. - :ref:`float<class_float>` **radial_accel_random**
  543. +----------+-----------------------------+
  544. | *Setter* | set_param_randomness(value) |
  545. +----------+-----------------------------+
  546. | *Getter* | get_param_randomness() |
  547. +----------+-----------------------------+
  548. .. _class_CPUParticles_property_randomness:
  549. - :ref:`float<class_float>` **randomness**
  550. +----------+-----------------------------+
  551. | *Setter* | set_randomness_ratio(value) |
  552. +----------+-----------------------------+
  553. | *Getter* | get_randomness_ratio() |
  554. +----------+-----------------------------+
  555. .. _class_CPUParticles_property_scale_amount:
  556. - :ref:`float<class_float>` **scale_amount**
  557. +----------+------------------+
  558. | *Setter* | set_param(value) |
  559. +----------+------------------+
  560. | *Getter* | get_param() |
  561. +----------+------------------+
  562. .. _class_CPUParticles_property_scale_amount_curve:
  563. - :ref:`Curve<class_Curve>` **scale_amount_curve**
  564. +----------+------------------------+
  565. | *Setter* | set_param_curve(value) |
  566. +----------+------------------------+
  567. | *Getter* | get_param_curve() |
  568. +----------+------------------------+
  569. .. _class_CPUParticles_property_scale_amount_random:
  570. - :ref:`float<class_float>` **scale_amount_random**
  571. +----------+-----------------------------+
  572. | *Setter* | set_param_randomness(value) |
  573. +----------+-----------------------------+
  574. | *Getter* | get_param_randomness() |
  575. +----------+-----------------------------+
  576. .. _class_CPUParticles_property_speed_scale:
  577. - :ref:`float<class_float>` **speed_scale**
  578. +----------+------------------------+
  579. | *Setter* | set_speed_scale(value) |
  580. +----------+------------------------+
  581. | *Getter* | get_speed_scale() |
  582. +----------+------------------------+
  583. .. _class_CPUParticles_property_spread:
  584. - :ref:`float<class_float>` **spread**
  585. +----------+-------------------+
  586. | *Setter* | set_spread(value) |
  587. +----------+-------------------+
  588. | *Getter* | get_spread() |
  589. +----------+-------------------+
  590. .. _class_CPUParticles_property_tangential_accel:
  591. - :ref:`float<class_float>` **tangential_accel**
  592. +----------+------------------+
  593. | *Setter* | set_param(value) |
  594. +----------+------------------+
  595. | *Getter* | get_param() |
  596. +----------+------------------+
  597. .. _class_CPUParticles_property_tangential_accel_curve:
  598. - :ref:`Curve<class_Curve>` **tangential_accel_curve**
  599. +----------+------------------------+
  600. | *Setter* | set_param_curve(value) |
  601. +----------+------------------------+
  602. | *Getter* | get_param_curve() |
  603. +----------+------------------------+
  604. .. _class_CPUParticles_property_tangential_accel_random:
  605. - :ref:`float<class_float>` **tangential_accel_random**
  606. +----------+-----------------------------+
  607. | *Setter* | set_param_randomness(value) |
  608. +----------+-----------------------------+
  609. | *Getter* | get_param_randomness() |
  610. +----------+-----------------------------+
  611. Method Descriptions
  612. -------------------
  613. .. _class_CPUParticles_method_convert_from_particles:
  614. - void **convert_from_particles** **(** :ref:`Node<class_Node>` particles **)**
  615. .. _class_CPUParticles_method_restart:
  616. - void **restart** **(** **)**