class_cpuparticles2d.rst 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805
  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_amount>` |
  15. +---------------------------------------------------------+------------------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`angle<class_CPUParticles2D_angle>` |
  17. +---------------------------------------------------------+------------------------------------------------------------------------------+
  18. | :ref:`Curve<class_Curve>` | :ref:`angle_curve<class_CPUParticles2D_angle_curve>` |
  19. +---------------------------------------------------------+------------------------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`angle_random<class_CPUParticles2D_angle_random>` |
  21. +---------------------------------------------------------+------------------------------------------------------------------------------+
  22. | :ref:`float<class_float>` | :ref:`angular_velocity<class_CPUParticles2D_angular_velocity>` |
  23. +---------------------------------------------------------+------------------------------------------------------------------------------+
  24. | :ref:`Curve<class_Curve>` | :ref:`angular_velocity_curve<class_CPUParticles2D_angular_velocity_curve>` |
  25. +---------------------------------------------------------+------------------------------------------------------------------------------+
  26. | :ref:`float<class_float>` | :ref:`angular_velocity_random<class_CPUParticles2D_angular_velocity_random>` |
  27. +---------------------------------------------------------+------------------------------------------------------------------------------+
  28. | :ref:`float<class_float>` | :ref:`anim_offset<class_CPUParticles2D_anim_offset>` |
  29. +---------------------------------------------------------+------------------------------------------------------------------------------+
  30. | :ref:`Curve<class_Curve>` | :ref:`anim_offset_curve<class_CPUParticles2D_anim_offset_curve>` |
  31. +---------------------------------------------------------+------------------------------------------------------------------------------+
  32. | :ref:`float<class_float>` | :ref:`anim_offset_random<class_CPUParticles2D_anim_offset_random>` |
  33. +---------------------------------------------------------+------------------------------------------------------------------------------+
  34. | :ref:`float<class_float>` | :ref:`anim_speed<class_CPUParticles2D_anim_speed>` |
  35. +---------------------------------------------------------+------------------------------------------------------------------------------+
  36. | :ref:`Curve<class_Curve>` | :ref:`anim_speed_curve<class_CPUParticles2D_anim_speed_curve>` |
  37. +---------------------------------------------------------+------------------------------------------------------------------------------+
  38. | :ref:`float<class_float>` | :ref:`anim_speed_random<class_CPUParticles2D_anim_speed_random>` |
  39. +---------------------------------------------------------+------------------------------------------------------------------------------+
  40. | :ref:`Color<class_Color>` | :ref:`color<class_CPUParticles2D_color>` |
  41. +---------------------------------------------------------+------------------------------------------------------------------------------+
  42. | :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_CPUParticles2D_color_ramp>` |
  43. +---------------------------------------------------------+------------------------------------------------------------------------------+
  44. | :ref:`float<class_float>` | :ref:`damping<class_CPUParticles2D_damping>` |
  45. +---------------------------------------------------------+------------------------------------------------------------------------------+
  46. | :ref:`Curve<class_Curve>` | :ref:`damping_curve<class_CPUParticles2D_damping_curve>` |
  47. +---------------------------------------------------------+------------------------------------------------------------------------------+
  48. | :ref:`float<class_float>` | :ref:`damping_random<class_CPUParticles2D_damping_random>` |
  49. +---------------------------------------------------------+------------------------------------------------------------------------------+
  50. | :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` | :ref:`draw_order<class_CPUParticles2D_draw_order>` |
  51. +---------------------------------------------------------+------------------------------------------------------------------------------+
  52. | :ref:`PoolColorArray<class_PoolColorArray>` | :ref:`emission_colors<class_CPUParticles2D_emission_colors>` |
  53. +---------------------------------------------------------+------------------------------------------------------------------------------+
  54. | :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`emission_normals<class_CPUParticles2D_emission_normals>` |
  55. +---------------------------------------------------------+------------------------------------------------------------------------------+
  56. | :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`emission_points<class_CPUParticles2D_emission_points>` |
  57. +---------------------------------------------------------+------------------------------------------------------------------------------+
  58. | :ref:`Vector2<class_Vector2>` | :ref:`emission_rect_extents<class_CPUParticles2D_emission_rect_extents>` |
  59. +---------------------------------------------------------+------------------------------------------------------------------------------+
  60. | :ref:`EmissionShape<enum_CPUParticles2D_EmissionShape>` | :ref:`emission_shape<class_CPUParticles2D_emission_shape>` |
  61. +---------------------------------------------------------+------------------------------------------------------------------------------+
  62. | :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_CPUParticles2D_emission_sphere_radius>` |
  63. +---------------------------------------------------------+------------------------------------------------------------------------------+
  64. | :ref:`bool<class_bool>` | :ref:`emitting<class_CPUParticles2D_emitting>` |
  65. +---------------------------------------------------------+------------------------------------------------------------------------------+
  66. | :ref:`float<class_float>` | :ref:`explosiveness<class_CPUParticles2D_explosiveness>` |
  67. +---------------------------------------------------------+------------------------------------------------------------------------------+
  68. | :ref:`int<class_int>` | :ref:`fixed_fps<class_CPUParticles2D_fixed_fps>` |
  69. +---------------------------------------------------------+------------------------------------------------------------------------------+
  70. | :ref:`bool<class_bool>` | :ref:`flag_align_y<class_CPUParticles2D_flag_align_y>` |
  71. +---------------------------------------------------------+------------------------------------------------------------------------------+
  72. | :ref:`float<class_float>` | :ref:`flatness<class_CPUParticles2D_flatness>` |
  73. +---------------------------------------------------------+------------------------------------------------------------------------------+
  74. | :ref:`bool<class_bool>` | :ref:`fract_delta<class_CPUParticles2D_fract_delta>` |
  75. +---------------------------------------------------------+------------------------------------------------------------------------------+
  76. | :ref:`Vector2<class_Vector2>` | :ref:`gravity<class_CPUParticles2D_gravity>` |
  77. +---------------------------------------------------------+------------------------------------------------------------------------------+
  78. | :ref:`float<class_float>` | :ref:`hue_variation<class_CPUParticles2D_hue_variation>` |
  79. +---------------------------------------------------------+------------------------------------------------------------------------------+
  80. | :ref:`Curve<class_Curve>` | :ref:`hue_variation_curve<class_CPUParticles2D_hue_variation_curve>` |
  81. +---------------------------------------------------------+------------------------------------------------------------------------------+
  82. | :ref:`float<class_float>` | :ref:`hue_variation_random<class_CPUParticles2D_hue_variation_random>` |
  83. +---------------------------------------------------------+------------------------------------------------------------------------------+
  84. | :ref:`float<class_float>` | :ref:`initial_velocity<class_CPUParticles2D_initial_velocity>` |
  85. +---------------------------------------------------------+------------------------------------------------------------------------------+
  86. | :ref:`float<class_float>` | :ref:`initial_velocity_random<class_CPUParticles2D_initial_velocity_random>` |
  87. +---------------------------------------------------------+------------------------------------------------------------------------------+
  88. | :ref:`float<class_float>` | :ref:`lifetime<class_CPUParticles2D_lifetime>` |
  89. +---------------------------------------------------------+------------------------------------------------------------------------------+
  90. | :ref:`float<class_float>` | :ref:`linear_accel<class_CPUParticles2D_linear_accel>` |
  91. +---------------------------------------------------------+------------------------------------------------------------------------------+
  92. | :ref:`Curve<class_Curve>` | :ref:`linear_accel_curve<class_CPUParticles2D_linear_accel_curve>` |
  93. +---------------------------------------------------------+------------------------------------------------------------------------------+
  94. | :ref:`float<class_float>` | :ref:`linear_accel_random<class_CPUParticles2D_linear_accel_random>` |
  95. +---------------------------------------------------------+------------------------------------------------------------------------------+
  96. | :ref:`bool<class_bool>` | :ref:`local_coords<class_CPUParticles2D_local_coords>` |
  97. +---------------------------------------------------------+------------------------------------------------------------------------------+
  98. | :ref:`Texture<class_Texture>` | :ref:`normalmap<class_CPUParticles2D_normalmap>` |
  99. +---------------------------------------------------------+------------------------------------------------------------------------------+
  100. | :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles2D_one_shot>` |
  101. +---------------------------------------------------------+------------------------------------------------------------------------------+
  102. | :ref:`float<class_float>` | :ref:`preprocess<class_CPUParticles2D_preprocess>` |
  103. +---------------------------------------------------------+------------------------------------------------------------------------------+
  104. | :ref:`float<class_float>` | :ref:`radial_accel<class_CPUParticles2D_radial_accel>` |
  105. +---------------------------------------------------------+------------------------------------------------------------------------------+
  106. | :ref:`Curve<class_Curve>` | :ref:`radial_accel_curve<class_CPUParticles2D_radial_accel_curve>` |
  107. +---------------------------------------------------------+------------------------------------------------------------------------------+
  108. | :ref:`float<class_float>` | :ref:`radial_accel_random<class_CPUParticles2D_radial_accel_random>` |
  109. +---------------------------------------------------------+------------------------------------------------------------------------------+
  110. | :ref:`float<class_float>` | :ref:`randomness<class_CPUParticles2D_randomness>` |
  111. +---------------------------------------------------------+------------------------------------------------------------------------------+
  112. | :ref:`float<class_float>` | :ref:`scale_amount<class_CPUParticles2D_scale_amount>` |
  113. +---------------------------------------------------------+------------------------------------------------------------------------------+
  114. | :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles2D_scale_amount_curve>` |
  115. +---------------------------------------------------------+------------------------------------------------------------------------------+
  116. | :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles2D_scale_amount_random>` |
  117. +---------------------------------------------------------+------------------------------------------------------------------------------+
  118. | :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles2D_speed_scale>` |
  119. +---------------------------------------------------------+------------------------------------------------------------------------------+
  120. | :ref:`float<class_float>` | :ref:`spread<class_CPUParticles2D_spread>` |
  121. +---------------------------------------------------------+------------------------------------------------------------------------------+
  122. | :ref:`float<class_float>` | :ref:`tangential_accel<class_CPUParticles2D_tangential_accel>` |
  123. +---------------------------------------------------------+------------------------------------------------------------------------------+
  124. | :ref:`Curve<class_Curve>` | :ref:`tangential_accel_curve<class_CPUParticles2D_tangential_accel_curve>` |
  125. +---------------------------------------------------------+------------------------------------------------------------------------------+
  126. | :ref:`float<class_float>` | :ref:`tangential_accel_random<class_CPUParticles2D_tangential_accel_random>` |
  127. +---------------------------------------------------------+------------------------------------------------------------------------------+
  128. | :ref:`Texture<class_Texture>` | :ref:`texture<class_CPUParticles2D_texture>` |
  129. +---------------------------------------------------------+------------------------------------------------------------------------------+
  130. Methods
  131. -------
  132. +-------+--------------------------------------------------------------------------------------------------------------------------+
  133. | void | :ref:`convert_from_particles<class_CPUParticles2D_convert_from_particles>` **(** :ref:`Node<class_Node>` particles **)** |
  134. +-------+--------------------------------------------------------------------------------------------------------------------------+
  135. | void | :ref:`restart<class_CPUParticles2D_restart>` **(** **)** |
  136. +-------+--------------------------------------------------------------------------------------------------------------------------+
  137. Enumerations
  138. ------------
  139. .. _enum_CPUParticles2D_Flags:
  140. enum **Flags**:
  141. - **FLAG_ALIGN_Y_TO_VELOCITY** = **0**
  142. - **FLAG_MAX** = **1**
  143. .. _enum_CPUParticles2D_Parameter:
  144. enum **Parameter**:
  145. - **PARAM_INITIAL_LINEAR_VELOCITY** = **0**
  146. - **PARAM_ANGULAR_VELOCITY** = **1**
  147. - **PARAM_ORBIT_VELOCITY** = **2**
  148. - **PARAM_LINEAR_ACCEL** = **3**
  149. - **PARAM_RADIAL_ACCEL** = **4**
  150. - **PARAM_TANGENTIAL_ACCEL** = **5**
  151. - **PARAM_DAMPING** = **6**
  152. - **PARAM_ANGLE** = **7**
  153. - **PARAM_SCALE** = **8**
  154. - **PARAM_HUE_VARIATION** = **9**
  155. - **PARAM_ANIM_SPEED** = **10**
  156. - **PARAM_ANIM_OFFSET** = **11**
  157. - **PARAM_MAX** = **12**
  158. .. _enum_CPUParticles2D_EmissionShape:
  159. enum **EmissionShape**:
  160. - **EMISSION_SHAPE_POINT** = **0**
  161. - **EMISSION_SHAPE_CIRCLE** = **1**
  162. - **EMISSION_SHAPE_RECTANGLE** = **2**
  163. - **EMISSION_SHAPE_POINTS** = **3**
  164. - **EMISSION_SHAPE_DIRECTED_POINTS** = **4**
  165. .. _enum_CPUParticles2D_DrawOrder:
  166. enum **DrawOrder**:
  167. - **DRAW_ORDER_INDEX** = **0**
  168. - **DRAW_ORDER_LIFETIME** = **1**
  169. Property Descriptions
  170. ---------------------
  171. .. _class_CPUParticles2D_amount:
  172. - :ref:`int<class_int>` **amount**
  173. +----------+-------------------+
  174. | *Setter* | set_amount(value) |
  175. +----------+-------------------+
  176. | *Getter* | get_amount() |
  177. +----------+-------------------+
  178. .. _class_CPUParticles2D_angle:
  179. - :ref:`float<class_float>` **angle**
  180. +----------+------------------+
  181. | *Setter* | set_param(value) |
  182. +----------+------------------+
  183. | *Getter* | get_param() |
  184. +----------+------------------+
  185. .. _class_CPUParticles2D_angle_curve:
  186. - :ref:`Curve<class_Curve>` **angle_curve**
  187. +----------+------------------------+
  188. | *Setter* | set_param_curve(value) |
  189. +----------+------------------------+
  190. | *Getter* | get_param_curve() |
  191. +----------+------------------------+
  192. .. _class_CPUParticles2D_angle_random:
  193. - :ref:`float<class_float>` **angle_random**
  194. +----------+-----------------------------+
  195. | *Setter* | set_param_randomness(value) |
  196. +----------+-----------------------------+
  197. | *Getter* | get_param_randomness() |
  198. +----------+-----------------------------+
  199. .. _class_CPUParticles2D_angular_velocity:
  200. - :ref:`float<class_float>` **angular_velocity**
  201. +----------+------------------+
  202. | *Setter* | set_param(value) |
  203. +----------+------------------+
  204. | *Getter* | get_param() |
  205. +----------+------------------+
  206. .. _class_CPUParticles2D_angular_velocity_curve:
  207. - :ref:`Curve<class_Curve>` **angular_velocity_curve**
  208. +----------+------------------------+
  209. | *Setter* | set_param_curve(value) |
  210. +----------+------------------------+
  211. | *Getter* | get_param_curve() |
  212. +----------+------------------------+
  213. .. _class_CPUParticles2D_angular_velocity_random:
  214. - :ref:`float<class_float>` **angular_velocity_random**
  215. +----------+-----------------------------+
  216. | *Setter* | set_param_randomness(value) |
  217. +----------+-----------------------------+
  218. | *Getter* | get_param_randomness() |
  219. +----------+-----------------------------+
  220. .. _class_CPUParticles2D_anim_offset:
  221. - :ref:`float<class_float>` **anim_offset**
  222. +----------+------------------+
  223. | *Setter* | set_param(value) |
  224. +----------+------------------+
  225. | *Getter* | get_param() |
  226. +----------+------------------+
  227. .. _class_CPUParticles2D_anim_offset_curve:
  228. - :ref:`Curve<class_Curve>` **anim_offset_curve**
  229. +----------+------------------------+
  230. | *Setter* | set_param_curve(value) |
  231. +----------+------------------------+
  232. | *Getter* | get_param_curve() |
  233. +----------+------------------------+
  234. .. _class_CPUParticles2D_anim_offset_random:
  235. - :ref:`float<class_float>` **anim_offset_random**
  236. +----------+-----------------------------+
  237. | *Setter* | set_param_randomness(value) |
  238. +----------+-----------------------------+
  239. | *Getter* | get_param_randomness() |
  240. +----------+-----------------------------+
  241. .. _class_CPUParticles2D_anim_speed:
  242. - :ref:`float<class_float>` **anim_speed**
  243. +----------+------------------+
  244. | *Setter* | set_param(value) |
  245. +----------+------------------+
  246. | *Getter* | get_param() |
  247. +----------+------------------+
  248. .. _class_CPUParticles2D_anim_speed_curve:
  249. - :ref:`Curve<class_Curve>` **anim_speed_curve**
  250. +----------+------------------------+
  251. | *Setter* | set_param_curve(value) |
  252. +----------+------------------------+
  253. | *Getter* | get_param_curve() |
  254. +----------+------------------------+
  255. .. _class_CPUParticles2D_anim_speed_random:
  256. - :ref:`float<class_float>` **anim_speed_random**
  257. +----------+-----------------------------+
  258. | *Setter* | set_param_randomness(value) |
  259. +----------+-----------------------------+
  260. | *Getter* | get_param_randomness() |
  261. +----------+-----------------------------+
  262. .. _class_CPUParticles2D_color:
  263. - :ref:`Color<class_Color>` **color**
  264. +----------+------------------+
  265. | *Setter* | set_color(value) |
  266. +----------+------------------+
  267. | *Getter* | get_color() |
  268. +----------+------------------+
  269. .. _class_CPUParticles2D_color_ramp:
  270. - :ref:`Gradient<class_Gradient>` **color_ramp**
  271. +----------+-----------------------+
  272. | *Setter* | set_color_ramp(value) |
  273. +----------+-----------------------+
  274. | *Getter* | get_color_ramp() |
  275. +----------+-----------------------+
  276. .. _class_CPUParticles2D_damping:
  277. - :ref:`float<class_float>` **damping**
  278. +----------+------------------+
  279. | *Setter* | set_param(value) |
  280. +----------+------------------+
  281. | *Getter* | get_param() |
  282. +----------+------------------+
  283. .. _class_CPUParticles2D_damping_curve:
  284. - :ref:`Curve<class_Curve>` **damping_curve**
  285. +----------+------------------------+
  286. | *Setter* | set_param_curve(value) |
  287. +----------+------------------------+
  288. | *Getter* | get_param_curve() |
  289. +----------+------------------------+
  290. .. _class_CPUParticles2D_damping_random:
  291. - :ref:`float<class_float>` **damping_random**
  292. +----------+-----------------------------+
  293. | *Setter* | set_param_randomness(value) |
  294. +----------+-----------------------------+
  295. | *Getter* | get_param_randomness() |
  296. +----------+-----------------------------+
  297. .. _class_CPUParticles2D_draw_order:
  298. - :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` **draw_order**
  299. +----------+-----------------------+
  300. | *Setter* | set_draw_order(value) |
  301. +----------+-----------------------+
  302. | *Getter* | get_draw_order() |
  303. +----------+-----------------------+
  304. .. _class_CPUParticles2D_emission_colors:
  305. - :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors**
  306. +----------+----------------------------+
  307. | *Setter* | set_emission_colors(value) |
  308. +----------+----------------------------+
  309. | *Getter* | get_emission_colors() |
  310. +----------+----------------------------+
  311. .. _class_CPUParticles2D_emission_normals:
  312. - :ref:`PoolVector2Array<class_PoolVector2Array>` **emission_normals**
  313. +----------+-----------------------------+
  314. | *Setter* | set_emission_normals(value) |
  315. +----------+-----------------------------+
  316. | *Getter* | get_emission_normals() |
  317. +----------+-----------------------------+
  318. .. _class_CPUParticles2D_emission_points:
  319. - :ref:`PoolVector2Array<class_PoolVector2Array>` **emission_points**
  320. +----------+----------------------------+
  321. | *Setter* | set_emission_points(value) |
  322. +----------+----------------------------+
  323. | *Getter* | get_emission_points() |
  324. +----------+----------------------------+
  325. .. _class_CPUParticles2D_emission_rect_extents:
  326. - :ref:`Vector2<class_Vector2>` **emission_rect_extents**
  327. +----------+----------------------------------+
  328. | *Setter* | set_emission_rect_extents(value) |
  329. +----------+----------------------------------+
  330. | *Getter* | get_emission_rect_extents() |
  331. +----------+----------------------------------+
  332. .. _class_CPUParticles2D_emission_shape:
  333. - :ref:`EmissionShape<enum_CPUParticles2D_EmissionShape>` **emission_shape**
  334. +----------+---------------------------+
  335. | *Setter* | set_emission_shape(value) |
  336. +----------+---------------------------+
  337. | *Getter* | get_emission_shape() |
  338. +----------+---------------------------+
  339. .. _class_CPUParticles2D_emission_sphere_radius:
  340. - :ref:`float<class_float>` **emission_sphere_radius**
  341. +----------+-----------------------------------+
  342. | *Setter* | set_emission_sphere_radius(value) |
  343. +----------+-----------------------------------+
  344. | *Getter* | get_emission_sphere_radius() |
  345. +----------+-----------------------------------+
  346. .. _class_CPUParticles2D_emitting:
  347. - :ref:`bool<class_bool>` **emitting**
  348. +----------+---------------------+
  349. | *Setter* | set_emitting(value) |
  350. +----------+---------------------+
  351. | *Getter* | is_emitting() |
  352. +----------+---------------------+
  353. .. _class_CPUParticles2D_explosiveness:
  354. - :ref:`float<class_float>` **explosiveness**
  355. +----------+--------------------------------+
  356. | *Setter* | set_explosiveness_ratio(value) |
  357. +----------+--------------------------------+
  358. | *Getter* | get_explosiveness_ratio() |
  359. +----------+--------------------------------+
  360. .. _class_CPUParticles2D_fixed_fps:
  361. - :ref:`int<class_int>` **fixed_fps**
  362. +----------+----------------------+
  363. | *Setter* | set_fixed_fps(value) |
  364. +----------+----------------------+
  365. | *Getter* | get_fixed_fps() |
  366. +----------+----------------------+
  367. .. _class_CPUParticles2D_flag_align_y:
  368. - :ref:`bool<class_bool>` **flag_align_y**
  369. +----------+--------------------------+
  370. | *Setter* | set_particle_flag(value) |
  371. +----------+--------------------------+
  372. | *Getter* | get_particle_flag() |
  373. +----------+--------------------------+
  374. .. _class_CPUParticles2D_flatness:
  375. - :ref:`float<class_float>` **flatness**
  376. +----------+---------------------+
  377. | *Setter* | set_flatness(value) |
  378. +----------+---------------------+
  379. | *Getter* | get_flatness() |
  380. +----------+---------------------+
  381. .. _class_CPUParticles2D_fract_delta:
  382. - :ref:`bool<class_bool>` **fract_delta**
  383. +----------+-----------------------------+
  384. | *Setter* | set_fractional_delta(value) |
  385. +----------+-----------------------------+
  386. | *Getter* | get_fractional_delta() |
  387. +----------+-----------------------------+
  388. .. _class_CPUParticles2D_gravity:
  389. - :ref:`Vector2<class_Vector2>` **gravity**
  390. +----------+--------------------+
  391. | *Setter* | set_gravity(value) |
  392. +----------+--------------------+
  393. | *Getter* | get_gravity() |
  394. +----------+--------------------+
  395. .. _class_CPUParticles2D_hue_variation:
  396. - :ref:`float<class_float>` **hue_variation**
  397. +----------+------------------+
  398. | *Setter* | set_param(value) |
  399. +----------+------------------+
  400. | *Getter* | get_param() |
  401. +----------+------------------+
  402. .. _class_CPUParticles2D_hue_variation_curve:
  403. - :ref:`Curve<class_Curve>` **hue_variation_curve**
  404. +----------+------------------------+
  405. | *Setter* | set_param_curve(value) |
  406. +----------+------------------------+
  407. | *Getter* | get_param_curve() |
  408. +----------+------------------------+
  409. .. _class_CPUParticles2D_hue_variation_random:
  410. - :ref:`float<class_float>` **hue_variation_random**
  411. +----------+-----------------------------+
  412. | *Setter* | set_param_randomness(value) |
  413. +----------+-----------------------------+
  414. | *Getter* | get_param_randomness() |
  415. +----------+-----------------------------+
  416. .. _class_CPUParticles2D_initial_velocity:
  417. - :ref:`float<class_float>` **initial_velocity**
  418. +----------+------------------+
  419. | *Setter* | set_param(value) |
  420. +----------+------------------+
  421. | *Getter* | get_param() |
  422. +----------+------------------+
  423. .. _class_CPUParticles2D_initial_velocity_random:
  424. - :ref:`float<class_float>` **initial_velocity_random**
  425. +----------+-----------------------------+
  426. | *Setter* | set_param_randomness(value) |
  427. +----------+-----------------------------+
  428. | *Getter* | get_param_randomness() |
  429. +----------+-----------------------------+
  430. .. _class_CPUParticles2D_lifetime:
  431. - :ref:`float<class_float>` **lifetime**
  432. +----------+---------------------+
  433. | *Setter* | set_lifetime(value) |
  434. +----------+---------------------+
  435. | *Getter* | get_lifetime() |
  436. +----------+---------------------+
  437. .. _class_CPUParticles2D_linear_accel:
  438. - :ref:`float<class_float>` **linear_accel**
  439. +----------+------------------+
  440. | *Setter* | set_param(value) |
  441. +----------+------------------+
  442. | *Getter* | get_param() |
  443. +----------+------------------+
  444. .. _class_CPUParticles2D_linear_accel_curve:
  445. - :ref:`Curve<class_Curve>` **linear_accel_curve**
  446. +----------+------------------------+
  447. | *Setter* | set_param_curve(value) |
  448. +----------+------------------------+
  449. | *Getter* | get_param_curve() |
  450. +----------+------------------------+
  451. .. _class_CPUParticles2D_linear_accel_random:
  452. - :ref:`float<class_float>` **linear_accel_random**
  453. +----------+-----------------------------+
  454. | *Setter* | set_param_randomness(value) |
  455. +----------+-----------------------------+
  456. | *Getter* | get_param_randomness() |
  457. +----------+-----------------------------+
  458. .. _class_CPUParticles2D_local_coords:
  459. - :ref:`bool<class_bool>` **local_coords**
  460. +----------+----------------------------------+
  461. | *Setter* | set_use_local_coordinates(value) |
  462. +----------+----------------------------------+
  463. | *Getter* | get_use_local_coordinates() |
  464. +----------+----------------------------------+
  465. .. _class_CPUParticles2D_normalmap:
  466. - :ref:`Texture<class_Texture>` **normalmap**
  467. +----------+----------------------+
  468. | *Setter* | set_normalmap(value) |
  469. +----------+----------------------+
  470. | *Getter* | get_normalmap() |
  471. +----------+----------------------+
  472. .. _class_CPUParticles2D_one_shot:
  473. - :ref:`bool<class_bool>` **one_shot**
  474. +----------+---------------------+
  475. | *Setter* | set_one_shot(value) |
  476. +----------+---------------------+
  477. | *Getter* | get_one_shot() |
  478. +----------+---------------------+
  479. .. _class_CPUParticles2D_preprocess:
  480. - :ref:`float<class_float>` **preprocess**
  481. +----------+-----------------------------+
  482. | *Setter* | set_pre_process_time(value) |
  483. +----------+-----------------------------+
  484. | *Getter* | get_pre_process_time() |
  485. +----------+-----------------------------+
  486. .. _class_CPUParticles2D_radial_accel:
  487. - :ref:`float<class_float>` **radial_accel**
  488. +----------+------------------+
  489. | *Setter* | set_param(value) |
  490. +----------+------------------+
  491. | *Getter* | get_param() |
  492. +----------+------------------+
  493. .. _class_CPUParticles2D_radial_accel_curve:
  494. - :ref:`Curve<class_Curve>` **radial_accel_curve**
  495. +----------+------------------------+
  496. | *Setter* | set_param_curve(value) |
  497. +----------+------------------------+
  498. | *Getter* | get_param_curve() |
  499. +----------+------------------------+
  500. .. _class_CPUParticles2D_radial_accel_random:
  501. - :ref:`float<class_float>` **radial_accel_random**
  502. +----------+-----------------------------+
  503. | *Setter* | set_param_randomness(value) |
  504. +----------+-----------------------------+
  505. | *Getter* | get_param_randomness() |
  506. +----------+-----------------------------+
  507. .. _class_CPUParticles2D_randomness:
  508. - :ref:`float<class_float>` **randomness**
  509. +----------+-----------------------------+
  510. | *Setter* | set_randomness_ratio(value) |
  511. +----------+-----------------------------+
  512. | *Getter* | get_randomness_ratio() |
  513. +----------+-----------------------------+
  514. .. _class_CPUParticles2D_scale_amount:
  515. - :ref:`float<class_float>` **scale_amount**
  516. +----------+------------------+
  517. | *Setter* | set_param(value) |
  518. +----------+------------------+
  519. | *Getter* | get_param() |
  520. +----------+------------------+
  521. .. _class_CPUParticles2D_scale_amount_curve:
  522. - :ref:`Curve<class_Curve>` **scale_amount_curve**
  523. +----------+------------------------+
  524. | *Setter* | set_param_curve(value) |
  525. +----------+------------------------+
  526. | *Getter* | get_param_curve() |
  527. +----------+------------------------+
  528. .. _class_CPUParticles2D_scale_amount_random:
  529. - :ref:`float<class_float>` **scale_amount_random**
  530. +----------+-----------------------------+
  531. | *Setter* | set_param_randomness(value) |
  532. +----------+-----------------------------+
  533. | *Getter* | get_param_randomness() |
  534. +----------+-----------------------------+
  535. .. _class_CPUParticles2D_speed_scale:
  536. - :ref:`float<class_float>` **speed_scale**
  537. +----------+------------------------+
  538. | *Setter* | set_speed_scale(value) |
  539. +----------+------------------------+
  540. | *Getter* | get_speed_scale() |
  541. +----------+------------------------+
  542. .. _class_CPUParticles2D_spread:
  543. - :ref:`float<class_float>` **spread**
  544. +----------+-------------------+
  545. | *Setter* | set_spread(value) |
  546. +----------+-------------------+
  547. | *Getter* | get_spread() |
  548. +----------+-------------------+
  549. .. _class_CPUParticles2D_tangential_accel:
  550. - :ref:`float<class_float>` **tangential_accel**
  551. +----------+------------------+
  552. | *Setter* | set_param(value) |
  553. +----------+------------------+
  554. | *Getter* | get_param() |
  555. +----------+------------------+
  556. .. _class_CPUParticles2D_tangential_accel_curve:
  557. - :ref:`Curve<class_Curve>` **tangential_accel_curve**
  558. +----------+------------------------+
  559. | *Setter* | set_param_curve(value) |
  560. +----------+------------------------+
  561. | *Getter* | get_param_curve() |
  562. +----------+------------------------+
  563. .. _class_CPUParticles2D_tangential_accel_random:
  564. - :ref:`float<class_float>` **tangential_accel_random**
  565. +----------+-----------------------------+
  566. | *Setter* | set_param_randomness(value) |
  567. +----------+-----------------------------+
  568. | *Getter* | get_param_randomness() |
  569. +----------+-----------------------------+
  570. .. _class_CPUParticles2D_texture:
  571. - :ref:`Texture<class_Texture>` **texture**
  572. +----------+--------------------+
  573. | *Setter* | set_texture(value) |
  574. +----------+--------------------+
  575. | *Getter* | get_texture() |
  576. +----------+--------------------+
  577. Method Descriptions
  578. -------------------
  579. .. _class_CPUParticles2D_convert_from_particles:
  580. - void **convert_from_particles** **(** :ref:`Node<class_Node>` particles **)**
  581. .. _class_CPUParticles2D_restart:
  582. - void **restart** **(** **)**