class_cpuparticles2d.rst 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the CPUParticles2D.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_CPUParticles2D:
  5. CPUParticles2D
  6. ==============
  7. **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :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_CPUParticles2D_property_amount>` |
  15. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`angle<class_CPUParticles2D_property_angle>` |
  17. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  18. | :ref:`Curve<class_Curve>` | :ref:`angle_curve<class_CPUParticles2D_property_angle_curve>` |
  19. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`angle_random<class_CPUParticles2D_property_angle_random>` |
  21. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  22. | :ref:`float<class_float>` | :ref:`angular_velocity<class_CPUParticles2D_property_angular_velocity>` |
  23. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  24. | :ref:`Curve<class_Curve>` | :ref:`angular_velocity_curve<class_CPUParticles2D_property_angular_velocity_curve>` |
  25. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  26. | :ref:`float<class_float>` | :ref:`angular_velocity_random<class_CPUParticles2D_property_angular_velocity_random>` |
  27. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  28. | :ref:`float<class_float>` | :ref:`anim_offset<class_CPUParticles2D_property_anim_offset>` |
  29. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  30. | :ref:`Curve<class_Curve>` | :ref:`anim_offset_curve<class_CPUParticles2D_property_anim_offset_curve>` |
  31. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  32. | :ref:`float<class_float>` | :ref:`anim_offset_random<class_CPUParticles2D_property_anim_offset_random>` |
  33. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  34. | :ref:`float<class_float>` | :ref:`anim_speed<class_CPUParticles2D_property_anim_speed>` |
  35. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  36. | :ref:`Curve<class_Curve>` | :ref:`anim_speed_curve<class_CPUParticles2D_property_anim_speed_curve>` |
  37. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  38. | :ref:`float<class_float>` | :ref:`anim_speed_random<class_CPUParticles2D_property_anim_speed_random>` |
  39. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  40. | :ref:`Color<class_Color>` | :ref:`color<class_CPUParticles2D_property_color>` |
  41. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  42. | :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_CPUParticles2D_property_color_ramp>` |
  43. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  44. | :ref:`float<class_float>` | :ref:`damping<class_CPUParticles2D_property_damping>` |
  45. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  46. | :ref:`Curve<class_Curve>` | :ref:`damping_curve<class_CPUParticles2D_property_damping_curve>` |
  47. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  48. | :ref:`float<class_float>` | :ref:`damping_random<class_CPUParticles2D_property_damping_random>` |
  49. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  50. | :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` | :ref:`draw_order<class_CPUParticles2D_property_draw_order>` |
  51. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  52. | :ref:`PoolColorArray<class_PoolColorArray>` | :ref:`emission_colors<class_CPUParticles2D_property_emission_colors>` |
  53. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  54. | :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`emission_normals<class_CPUParticles2D_property_emission_normals>` |
  55. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  56. | :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`emission_points<class_CPUParticles2D_property_emission_points>` |
  57. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  58. | :ref:`Vector2<class_Vector2>` | :ref:`emission_rect_extents<class_CPUParticles2D_property_emission_rect_extents>` |
  59. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  60. | :ref:`EmissionShape<enum_CPUParticles2D_EmissionShape>` | :ref:`emission_shape<class_CPUParticles2D_property_emission_shape>` |
  61. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  62. | :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_CPUParticles2D_property_emission_sphere_radius>` |
  63. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  64. | :ref:`bool<class_bool>` | :ref:`emitting<class_CPUParticles2D_property_emitting>` |
  65. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  66. | :ref:`float<class_float>` | :ref:`explosiveness<class_CPUParticles2D_property_explosiveness>` |
  67. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  68. | :ref:`int<class_int>` | :ref:`fixed_fps<class_CPUParticles2D_property_fixed_fps>` |
  69. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  70. | :ref:`bool<class_bool>` | :ref:`flag_align_y<class_CPUParticles2D_property_flag_align_y>` |
  71. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  72. | :ref:`float<class_float>` | :ref:`flatness<class_CPUParticles2D_property_flatness>` |
  73. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  74. | :ref:`bool<class_bool>` | :ref:`fract_delta<class_CPUParticles2D_property_fract_delta>` |
  75. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  76. | :ref:`Vector2<class_Vector2>` | :ref:`gravity<class_CPUParticles2D_property_gravity>` |
  77. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  78. | :ref:`float<class_float>` | :ref:`hue_variation<class_CPUParticles2D_property_hue_variation>` |
  79. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  80. | :ref:`Curve<class_Curve>` | :ref:`hue_variation_curve<class_CPUParticles2D_property_hue_variation_curve>` |
  81. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  82. | :ref:`float<class_float>` | :ref:`hue_variation_random<class_CPUParticles2D_property_hue_variation_random>` |
  83. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  84. | :ref:`float<class_float>` | :ref:`initial_velocity<class_CPUParticles2D_property_initial_velocity>` |
  85. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  86. | :ref:`float<class_float>` | :ref:`initial_velocity_random<class_CPUParticles2D_property_initial_velocity_random>` |
  87. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  88. | :ref:`float<class_float>` | :ref:`lifetime<class_CPUParticles2D_property_lifetime>` |
  89. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  90. | :ref:`float<class_float>` | :ref:`linear_accel<class_CPUParticles2D_property_linear_accel>` |
  91. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  92. | :ref:`Curve<class_Curve>` | :ref:`linear_accel_curve<class_CPUParticles2D_property_linear_accel_curve>` |
  93. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  94. | :ref:`float<class_float>` | :ref:`linear_accel_random<class_CPUParticles2D_property_linear_accel_random>` |
  95. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  96. | :ref:`bool<class_bool>` | :ref:`local_coords<class_CPUParticles2D_property_local_coords>` |
  97. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  98. | :ref:`Texture<class_Texture>` | :ref:`normalmap<class_CPUParticles2D_property_normalmap>` |
  99. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  100. | :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles2D_property_one_shot>` |
  101. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  102. | :ref:`float<class_float>` | :ref:`preprocess<class_CPUParticles2D_property_preprocess>` |
  103. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  104. | :ref:`float<class_float>` | :ref:`radial_accel<class_CPUParticles2D_property_radial_accel>` |
  105. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  106. | :ref:`Curve<class_Curve>` | :ref:`radial_accel_curve<class_CPUParticles2D_property_radial_accel_curve>` |
  107. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  108. | :ref:`float<class_float>` | :ref:`radial_accel_random<class_CPUParticles2D_property_radial_accel_random>` |
  109. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  110. | :ref:`float<class_float>` | :ref:`randomness<class_CPUParticles2D_property_randomness>` |
  111. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  112. | :ref:`float<class_float>` | :ref:`scale_amount<class_CPUParticles2D_property_scale_amount>` |
  113. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  114. | :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles2D_property_scale_amount_curve>` |
  115. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  116. | :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles2D_property_scale_amount_random>` |
  117. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  118. | :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles2D_property_speed_scale>` |
  119. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  120. | :ref:`float<class_float>` | :ref:`spread<class_CPUParticles2D_property_spread>` |
  121. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  122. | :ref:`float<class_float>` | :ref:`tangential_accel<class_CPUParticles2D_property_tangential_accel>` |
  123. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  124. | :ref:`Curve<class_Curve>` | :ref:`tangential_accel_curve<class_CPUParticles2D_property_tangential_accel_curve>` |
  125. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  126. | :ref:`float<class_float>` | :ref:`tangential_accel_random<class_CPUParticles2D_property_tangential_accel_random>` |
  127. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  128. | :ref:`Texture<class_Texture>` | :ref:`texture<class_CPUParticles2D_property_texture>` |
  129. +---------------------------------------------------------+---------------------------------------------------------------------------------------+
  130. Methods
  131. -------
  132. +------+---------------------------------------------------------------------------------------------------------------------------------+
  133. | void | :ref:`convert_from_particles<class_CPUParticles2D_method_convert_from_particles>` **(** :ref:`Node<class_Node>` particles **)** |
  134. +------+---------------------------------------------------------------------------------------------------------------------------------+
  135. | void | :ref:`restart<class_CPUParticles2D_method_restart>` **(** **)** |
  136. +------+---------------------------------------------------------------------------------------------------------------------------------+
  137. Enumerations
  138. ------------
  139. .. _enum_CPUParticles2D_DrawOrder:
  140. .. _class_CPUParticles2D_constant_DRAW_ORDER_INDEX:
  141. .. _class_CPUParticles2D_constant_DRAW_ORDER_LIFETIME:
  142. enum **DrawOrder**:
  143. - **DRAW_ORDER_INDEX** = **0**
  144. - **DRAW_ORDER_LIFETIME** = **1**
  145. .. _enum_CPUParticles2D_Parameter:
  146. .. _class_CPUParticles2D_constant_PARAM_INITIAL_LINEAR_VELOCITY:
  147. .. _class_CPUParticles2D_constant_PARAM_ANGULAR_VELOCITY:
  148. .. _class_CPUParticles2D_constant_PARAM_ORBIT_VELOCITY:
  149. .. _class_CPUParticles2D_constant_PARAM_LINEAR_ACCEL:
  150. .. _class_CPUParticles2D_constant_PARAM_RADIAL_ACCEL:
  151. .. _class_CPUParticles2D_constant_PARAM_TANGENTIAL_ACCEL:
  152. .. _class_CPUParticles2D_constant_PARAM_DAMPING:
  153. .. _class_CPUParticles2D_constant_PARAM_ANGLE:
  154. .. _class_CPUParticles2D_constant_PARAM_SCALE:
  155. .. _class_CPUParticles2D_constant_PARAM_HUE_VARIATION:
  156. .. _class_CPUParticles2D_constant_PARAM_ANIM_SPEED:
  157. .. _class_CPUParticles2D_constant_PARAM_ANIM_OFFSET:
  158. .. _class_CPUParticles2D_constant_PARAM_MAX:
  159. enum **Parameter**:
  160. - **PARAM_INITIAL_LINEAR_VELOCITY** = **0**
  161. - **PARAM_ANGULAR_VELOCITY** = **1**
  162. - **PARAM_ORBIT_VELOCITY** = **2**
  163. - **PARAM_LINEAR_ACCEL** = **3**
  164. - **PARAM_RADIAL_ACCEL** = **4**
  165. - **PARAM_TANGENTIAL_ACCEL** = **5**
  166. - **PARAM_DAMPING** = **6**
  167. - **PARAM_ANGLE** = **7**
  168. - **PARAM_SCALE** = **8**
  169. - **PARAM_HUE_VARIATION** = **9**
  170. - **PARAM_ANIM_SPEED** = **10**
  171. - **PARAM_ANIM_OFFSET** = **11**
  172. - **PARAM_MAX** = **12**
  173. .. _enum_CPUParticles2D_Flags:
  174. .. _class_CPUParticles2D_constant_FLAG_ALIGN_Y_TO_VELOCITY:
  175. .. _class_CPUParticles2D_constant_FLAG_MAX:
  176. enum **Flags**:
  177. - **FLAG_ALIGN_Y_TO_VELOCITY** = **0**
  178. - **FLAG_MAX** = **1**
  179. .. _enum_CPUParticles2D_EmissionShape:
  180. .. _class_CPUParticles2D_constant_EMISSION_SHAPE_POINT:
  181. .. _class_CPUParticles2D_constant_EMISSION_SHAPE_CIRCLE:
  182. .. _class_CPUParticles2D_constant_EMISSION_SHAPE_RECTANGLE:
  183. .. _class_CPUParticles2D_constant_EMISSION_SHAPE_POINTS:
  184. .. _class_CPUParticles2D_constant_EMISSION_SHAPE_DIRECTED_POINTS:
  185. enum **EmissionShape**:
  186. - **EMISSION_SHAPE_POINT** = **0**
  187. - **EMISSION_SHAPE_CIRCLE** = **1**
  188. - **EMISSION_SHAPE_RECTANGLE** = **2**
  189. - **EMISSION_SHAPE_POINTS** = **3**
  190. - **EMISSION_SHAPE_DIRECTED_POINTS** = **4**
  191. Property Descriptions
  192. ---------------------
  193. .. _class_CPUParticles2D_property_amount:
  194. - :ref:`int<class_int>` **amount**
  195. +----------+-------------------+
  196. | *Setter* | set_amount(value) |
  197. +----------+-------------------+
  198. | *Getter* | get_amount() |
  199. +----------+-------------------+
  200. .. _class_CPUParticles2D_property_angle:
  201. - :ref:`float<class_float>` **angle**
  202. +----------+------------------+
  203. | *Setter* | set_param(value) |
  204. +----------+------------------+
  205. | *Getter* | get_param() |
  206. +----------+------------------+
  207. .. _class_CPUParticles2D_property_angle_curve:
  208. - :ref:`Curve<class_Curve>` **angle_curve**
  209. +----------+------------------------+
  210. | *Setter* | set_param_curve(value) |
  211. +----------+------------------------+
  212. | *Getter* | get_param_curve() |
  213. +----------+------------------------+
  214. .. _class_CPUParticles2D_property_angle_random:
  215. - :ref:`float<class_float>` **angle_random**
  216. +----------+-----------------------------+
  217. | *Setter* | set_param_randomness(value) |
  218. +----------+-----------------------------+
  219. | *Getter* | get_param_randomness() |
  220. +----------+-----------------------------+
  221. .. _class_CPUParticles2D_property_angular_velocity:
  222. - :ref:`float<class_float>` **angular_velocity**
  223. +----------+------------------+
  224. | *Setter* | set_param(value) |
  225. +----------+------------------+
  226. | *Getter* | get_param() |
  227. +----------+------------------+
  228. .. _class_CPUParticles2D_property_angular_velocity_curve:
  229. - :ref:`Curve<class_Curve>` **angular_velocity_curve**
  230. +----------+------------------------+
  231. | *Setter* | set_param_curve(value) |
  232. +----------+------------------------+
  233. | *Getter* | get_param_curve() |
  234. +----------+------------------------+
  235. .. _class_CPUParticles2D_property_angular_velocity_random:
  236. - :ref:`float<class_float>` **angular_velocity_random**
  237. +----------+-----------------------------+
  238. | *Setter* | set_param_randomness(value) |
  239. +----------+-----------------------------+
  240. | *Getter* | get_param_randomness() |
  241. +----------+-----------------------------+
  242. .. _class_CPUParticles2D_property_anim_offset:
  243. - :ref:`float<class_float>` **anim_offset**
  244. +----------+------------------+
  245. | *Setter* | set_param(value) |
  246. +----------+------------------+
  247. | *Getter* | get_param() |
  248. +----------+------------------+
  249. .. _class_CPUParticles2D_property_anim_offset_curve:
  250. - :ref:`Curve<class_Curve>` **anim_offset_curve**
  251. +----------+------------------------+
  252. | *Setter* | set_param_curve(value) |
  253. +----------+------------------------+
  254. | *Getter* | get_param_curve() |
  255. +----------+------------------------+
  256. .. _class_CPUParticles2D_property_anim_offset_random:
  257. - :ref:`float<class_float>` **anim_offset_random**
  258. +----------+-----------------------------+
  259. | *Setter* | set_param_randomness(value) |
  260. +----------+-----------------------------+
  261. | *Getter* | get_param_randomness() |
  262. +----------+-----------------------------+
  263. .. _class_CPUParticles2D_property_anim_speed:
  264. - :ref:`float<class_float>` **anim_speed**
  265. +----------+------------------+
  266. | *Setter* | set_param(value) |
  267. +----------+------------------+
  268. | *Getter* | get_param() |
  269. +----------+------------------+
  270. .. _class_CPUParticles2D_property_anim_speed_curve:
  271. - :ref:`Curve<class_Curve>` **anim_speed_curve**
  272. +----------+------------------------+
  273. | *Setter* | set_param_curve(value) |
  274. +----------+------------------------+
  275. | *Getter* | get_param_curve() |
  276. +----------+------------------------+
  277. .. _class_CPUParticles2D_property_anim_speed_random:
  278. - :ref:`float<class_float>` **anim_speed_random**
  279. +----------+-----------------------------+
  280. | *Setter* | set_param_randomness(value) |
  281. +----------+-----------------------------+
  282. | *Getter* | get_param_randomness() |
  283. +----------+-----------------------------+
  284. .. _class_CPUParticles2D_property_color:
  285. - :ref:`Color<class_Color>` **color**
  286. +----------+------------------+
  287. | *Setter* | set_color(value) |
  288. +----------+------------------+
  289. | *Getter* | get_color() |
  290. +----------+------------------+
  291. .. _class_CPUParticles2D_property_color_ramp:
  292. - :ref:`Gradient<class_Gradient>` **color_ramp**
  293. +----------+-----------------------+
  294. | *Setter* | set_color_ramp(value) |
  295. +----------+-----------------------+
  296. | *Getter* | get_color_ramp() |
  297. +----------+-----------------------+
  298. .. _class_CPUParticles2D_property_damping:
  299. - :ref:`float<class_float>` **damping**
  300. +----------+------------------+
  301. | *Setter* | set_param(value) |
  302. +----------+------------------+
  303. | *Getter* | get_param() |
  304. +----------+------------------+
  305. .. _class_CPUParticles2D_property_damping_curve:
  306. - :ref:`Curve<class_Curve>` **damping_curve**
  307. +----------+------------------------+
  308. | *Setter* | set_param_curve(value) |
  309. +----------+------------------------+
  310. | *Getter* | get_param_curve() |
  311. +----------+------------------------+
  312. .. _class_CPUParticles2D_property_damping_random:
  313. - :ref:`float<class_float>` **damping_random**
  314. +----------+-----------------------------+
  315. | *Setter* | set_param_randomness(value) |
  316. +----------+-----------------------------+
  317. | *Getter* | get_param_randomness() |
  318. +----------+-----------------------------+
  319. .. _class_CPUParticles2D_property_draw_order:
  320. - :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` **draw_order**
  321. +----------+-----------------------+
  322. | *Setter* | set_draw_order(value) |
  323. +----------+-----------------------+
  324. | *Getter* | get_draw_order() |
  325. +----------+-----------------------+
  326. .. _class_CPUParticles2D_property_emission_colors:
  327. - :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors**
  328. +----------+----------------------------+
  329. | *Setter* | set_emission_colors(value) |
  330. +----------+----------------------------+
  331. | *Getter* | get_emission_colors() |
  332. +----------+----------------------------+
  333. .. _class_CPUParticles2D_property_emission_normals:
  334. - :ref:`PoolVector2Array<class_PoolVector2Array>` **emission_normals**
  335. +----------+-----------------------------+
  336. | *Setter* | set_emission_normals(value) |
  337. +----------+-----------------------------+
  338. | *Getter* | get_emission_normals() |
  339. +----------+-----------------------------+
  340. .. _class_CPUParticles2D_property_emission_points:
  341. - :ref:`PoolVector2Array<class_PoolVector2Array>` **emission_points**
  342. +----------+----------------------------+
  343. | *Setter* | set_emission_points(value) |
  344. +----------+----------------------------+
  345. | *Getter* | get_emission_points() |
  346. +----------+----------------------------+
  347. .. _class_CPUParticles2D_property_emission_rect_extents:
  348. - :ref:`Vector2<class_Vector2>` **emission_rect_extents**
  349. +----------+----------------------------------+
  350. | *Setter* | set_emission_rect_extents(value) |
  351. +----------+----------------------------------+
  352. | *Getter* | get_emission_rect_extents() |
  353. +----------+----------------------------------+
  354. .. _class_CPUParticles2D_property_emission_shape:
  355. - :ref:`EmissionShape<enum_CPUParticles2D_EmissionShape>` **emission_shape**
  356. +----------+---------------------------+
  357. | *Setter* | set_emission_shape(value) |
  358. +----------+---------------------------+
  359. | *Getter* | get_emission_shape() |
  360. +----------+---------------------------+
  361. .. _class_CPUParticles2D_property_emission_sphere_radius:
  362. - :ref:`float<class_float>` **emission_sphere_radius**
  363. +----------+-----------------------------------+
  364. | *Setter* | set_emission_sphere_radius(value) |
  365. +----------+-----------------------------------+
  366. | *Getter* | get_emission_sphere_radius() |
  367. +----------+-----------------------------------+
  368. .. _class_CPUParticles2D_property_emitting:
  369. - :ref:`bool<class_bool>` **emitting**
  370. +----------+---------------------+
  371. | *Setter* | set_emitting(value) |
  372. +----------+---------------------+
  373. | *Getter* | is_emitting() |
  374. +----------+---------------------+
  375. .. _class_CPUParticles2D_property_explosiveness:
  376. - :ref:`float<class_float>` **explosiveness**
  377. +----------+--------------------------------+
  378. | *Setter* | set_explosiveness_ratio(value) |
  379. +----------+--------------------------------+
  380. | *Getter* | get_explosiveness_ratio() |
  381. +----------+--------------------------------+
  382. .. _class_CPUParticles2D_property_fixed_fps:
  383. - :ref:`int<class_int>` **fixed_fps**
  384. +----------+----------------------+
  385. | *Setter* | set_fixed_fps(value) |
  386. +----------+----------------------+
  387. | *Getter* | get_fixed_fps() |
  388. +----------+----------------------+
  389. .. _class_CPUParticles2D_property_flag_align_y:
  390. - :ref:`bool<class_bool>` **flag_align_y**
  391. +----------+--------------------------+
  392. | *Setter* | set_particle_flag(value) |
  393. +----------+--------------------------+
  394. | *Getter* | get_particle_flag() |
  395. +----------+--------------------------+
  396. .. _class_CPUParticles2D_property_flatness:
  397. - :ref:`float<class_float>` **flatness**
  398. +----------+---------------------+
  399. | *Setter* | set_flatness(value) |
  400. +----------+---------------------+
  401. | *Getter* | get_flatness() |
  402. +----------+---------------------+
  403. .. _class_CPUParticles2D_property_fract_delta:
  404. - :ref:`bool<class_bool>` **fract_delta**
  405. +----------+-----------------------------+
  406. | *Setter* | set_fractional_delta(value) |
  407. +----------+-----------------------------+
  408. | *Getter* | get_fractional_delta() |
  409. +----------+-----------------------------+
  410. .. _class_CPUParticles2D_property_gravity:
  411. - :ref:`Vector2<class_Vector2>` **gravity**
  412. +----------+--------------------+
  413. | *Setter* | set_gravity(value) |
  414. +----------+--------------------+
  415. | *Getter* | get_gravity() |
  416. +----------+--------------------+
  417. .. _class_CPUParticles2D_property_hue_variation:
  418. - :ref:`float<class_float>` **hue_variation**
  419. +----------+------------------+
  420. | *Setter* | set_param(value) |
  421. +----------+------------------+
  422. | *Getter* | get_param() |
  423. +----------+------------------+
  424. .. _class_CPUParticles2D_property_hue_variation_curve:
  425. - :ref:`Curve<class_Curve>` **hue_variation_curve**
  426. +----------+------------------------+
  427. | *Setter* | set_param_curve(value) |
  428. +----------+------------------------+
  429. | *Getter* | get_param_curve() |
  430. +----------+------------------------+
  431. .. _class_CPUParticles2D_property_hue_variation_random:
  432. - :ref:`float<class_float>` **hue_variation_random**
  433. +----------+-----------------------------+
  434. | *Setter* | set_param_randomness(value) |
  435. +----------+-----------------------------+
  436. | *Getter* | get_param_randomness() |
  437. +----------+-----------------------------+
  438. .. _class_CPUParticles2D_property_initial_velocity:
  439. - :ref:`float<class_float>` **initial_velocity**
  440. +----------+------------------+
  441. | *Setter* | set_param(value) |
  442. +----------+------------------+
  443. | *Getter* | get_param() |
  444. +----------+------------------+
  445. .. _class_CPUParticles2D_property_initial_velocity_random:
  446. - :ref:`float<class_float>` **initial_velocity_random**
  447. +----------+-----------------------------+
  448. | *Setter* | set_param_randomness(value) |
  449. +----------+-----------------------------+
  450. | *Getter* | get_param_randomness() |
  451. +----------+-----------------------------+
  452. .. _class_CPUParticles2D_property_lifetime:
  453. - :ref:`float<class_float>` **lifetime**
  454. +----------+---------------------+
  455. | *Setter* | set_lifetime(value) |
  456. +----------+---------------------+
  457. | *Getter* | get_lifetime() |
  458. +----------+---------------------+
  459. .. _class_CPUParticles2D_property_linear_accel:
  460. - :ref:`float<class_float>` **linear_accel**
  461. +----------+------------------+
  462. | *Setter* | set_param(value) |
  463. +----------+------------------+
  464. | *Getter* | get_param() |
  465. +----------+------------------+
  466. .. _class_CPUParticles2D_property_linear_accel_curve:
  467. - :ref:`Curve<class_Curve>` **linear_accel_curve**
  468. +----------+------------------------+
  469. | *Setter* | set_param_curve(value) |
  470. +----------+------------------------+
  471. | *Getter* | get_param_curve() |
  472. +----------+------------------------+
  473. .. _class_CPUParticles2D_property_linear_accel_random:
  474. - :ref:`float<class_float>` **linear_accel_random**
  475. +----------+-----------------------------+
  476. | *Setter* | set_param_randomness(value) |
  477. +----------+-----------------------------+
  478. | *Getter* | get_param_randomness() |
  479. +----------+-----------------------------+
  480. .. _class_CPUParticles2D_property_local_coords:
  481. - :ref:`bool<class_bool>` **local_coords**
  482. +----------+----------------------------------+
  483. | *Setter* | set_use_local_coordinates(value) |
  484. +----------+----------------------------------+
  485. | *Getter* | get_use_local_coordinates() |
  486. +----------+----------------------------------+
  487. .. _class_CPUParticles2D_property_normalmap:
  488. - :ref:`Texture<class_Texture>` **normalmap**
  489. +----------+----------------------+
  490. | *Setter* | set_normalmap(value) |
  491. +----------+----------------------+
  492. | *Getter* | get_normalmap() |
  493. +----------+----------------------+
  494. .. _class_CPUParticles2D_property_one_shot:
  495. - :ref:`bool<class_bool>` **one_shot**
  496. +----------+---------------------+
  497. | *Setter* | set_one_shot(value) |
  498. +----------+---------------------+
  499. | *Getter* | get_one_shot() |
  500. +----------+---------------------+
  501. .. _class_CPUParticles2D_property_preprocess:
  502. - :ref:`float<class_float>` **preprocess**
  503. +----------+-----------------------------+
  504. | *Setter* | set_pre_process_time(value) |
  505. +----------+-----------------------------+
  506. | *Getter* | get_pre_process_time() |
  507. +----------+-----------------------------+
  508. .. _class_CPUParticles2D_property_radial_accel:
  509. - :ref:`float<class_float>` **radial_accel**
  510. +----------+------------------+
  511. | *Setter* | set_param(value) |
  512. +----------+------------------+
  513. | *Getter* | get_param() |
  514. +----------+------------------+
  515. .. _class_CPUParticles2D_property_radial_accel_curve:
  516. - :ref:`Curve<class_Curve>` **radial_accel_curve**
  517. +----------+------------------------+
  518. | *Setter* | set_param_curve(value) |
  519. +----------+------------------------+
  520. | *Getter* | get_param_curve() |
  521. +----------+------------------------+
  522. .. _class_CPUParticles2D_property_radial_accel_random:
  523. - :ref:`float<class_float>` **radial_accel_random**
  524. +----------+-----------------------------+
  525. | *Setter* | set_param_randomness(value) |
  526. +----------+-----------------------------+
  527. | *Getter* | get_param_randomness() |
  528. +----------+-----------------------------+
  529. .. _class_CPUParticles2D_property_randomness:
  530. - :ref:`float<class_float>` **randomness**
  531. +----------+-----------------------------+
  532. | *Setter* | set_randomness_ratio(value) |
  533. +----------+-----------------------------+
  534. | *Getter* | get_randomness_ratio() |
  535. +----------+-----------------------------+
  536. .. _class_CPUParticles2D_property_scale_amount:
  537. - :ref:`float<class_float>` **scale_amount**
  538. +----------+------------------+
  539. | *Setter* | set_param(value) |
  540. +----------+------------------+
  541. | *Getter* | get_param() |
  542. +----------+------------------+
  543. .. _class_CPUParticles2D_property_scale_amount_curve:
  544. - :ref:`Curve<class_Curve>` **scale_amount_curve**
  545. +----------+------------------------+
  546. | *Setter* | set_param_curve(value) |
  547. +----------+------------------------+
  548. | *Getter* | get_param_curve() |
  549. +----------+------------------------+
  550. .. _class_CPUParticles2D_property_scale_amount_random:
  551. - :ref:`float<class_float>` **scale_amount_random**
  552. +----------+-----------------------------+
  553. | *Setter* | set_param_randomness(value) |
  554. +----------+-----------------------------+
  555. | *Getter* | get_param_randomness() |
  556. +----------+-----------------------------+
  557. .. _class_CPUParticles2D_property_speed_scale:
  558. - :ref:`float<class_float>` **speed_scale**
  559. +----------+------------------------+
  560. | *Setter* | set_speed_scale(value) |
  561. +----------+------------------------+
  562. | *Getter* | get_speed_scale() |
  563. +----------+------------------------+
  564. .. _class_CPUParticles2D_property_spread:
  565. - :ref:`float<class_float>` **spread**
  566. +----------+-------------------+
  567. | *Setter* | set_spread(value) |
  568. +----------+-------------------+
  569. | *Getter* | get_spread() |
  570. +----------+-------------------+
  571. .. _class_CPUParticles2D_property_tangential_accel:
  572. - :ref:`float<class_float>` **tangential_accel**
  573. +----------+------------------+
  574. | *Setter* | set_param(value) |
  575. +----------+------------------+
  576. | *Getter* | get_param() |
  577. +----------+------------------+
  578. .. _class_CPUParticles2D_property_tangential_accel_curve:
  579. - :ref:`Curve<class_Curve>` **tangential_accel_curve**
  580. +----------+------------------------+
  581. | *Setter* | set_param_curve(value) |
  582. +----------+------------------------+
  583. | *Getter* | get_param_curve() |
  584. +----------+------------------------+
  585. .. _class_CPUParticles2D_property_tangential_accel_random:
  586. - :ref:`float<class_float>` **tangential_accel_random**
  587. +----------+-----------------------------+
  588. | *Setter* | set_param_randomness(value) |
  589. +----------+-----------------------------+
  590. | *Getter* | get_param_randomness() |
  591. +----------+-----------------------------+
  592. .. _class_CPUParticles2D_property_texture:
  593. - :ref:`Texture<class_Texture>` **texture**
  594. +----------+--------------------+
  595. | *Setter* | set_texture(value) |
  596. +----------+--------------------+
  597. | *Getter* | get_texture() |
  598. +----------+--------------------+
  599. Method Descriptions
  600. -------------------
  601. .. _class_CPUParticles2D_method_convert_from_particles:
  602. - void **convert_from_particles** **(** :ref:`Node<class_Node>` particles **)**
  603. .. _class_CPUParticles2D_method_restart:
  604. - void **restart** **(** **)**