Particles2D.xml 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="Particles2D" inherits="Node2D" category="Core" version="3.1">
  3. <brief_description>
  4. 2D particle emitter.
  5. </brief_description>
  6. <description>
  7. 2D particle node used to create a variety of particle systems and effects. [code]Particles2D[/code] features an emitter that generates some number of particles at a given rate.
  8. Use the [code]process_material[/code] property to add a [ParticlesMaterial] to configure particle appearance and behavior. Alternatively, you can add a [ShaderMaterial] which will be applied to all particles.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <demos>
  13. </demos>
  14. <methods>
  15. <method name="capture_rect" qualifiers="const">
  16. <return type="Rect2">
  17. </return>
  18. <description>
  19. </description>
  20. </method>
  21. <method name="restart">
  22. <return type="void">
  23. </return>
  24. <description>
  25. </description>
  26. </method>
  27. </methods>
  28. <members>
  29. <member name="amount" type="int" setter="set_amount" getter="get_amount">
  30. Number of particles emitted in one emission cycle.
  31. </member>
  32. <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="Particles2D.DrawOrder">
  33. Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. Default value: [code]DRAW_ORDER_INDEX[/code].
  34. </member>
  35. <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting">
  36. If [code]true[/code], particles are being emitted. Default value: [code]true[/code].
  37. </member>
  38. <member name="explosiveness" type="float" setter="set_explosiveness_ratio" getter="get_explosiveness_ratio">
  39. How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins. Default value: [code]0[/code].
  40. </member>
  41. <member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps">
  42. </member>
  43. <member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta">
  44. </member>
  45. <member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime">
  46. Amount of time each particle will exist. Default value: [code]1[/code].
  47. </member>
  48. <member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates">
  49. If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates. Default value: [code]true[/code].
  50. </member>
  51. <member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map">
  52. </member>
  53. <member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot">
  54. If [code]true[/code], only one emission cycle occurs. If set [code]true[/code] during a cycle, emission will stop at the cycle's end. Default value: [code]false[/code].
  55. </member>
  56. <member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time">
  57. Particle system starts as if it had already run for this many seconds.
  58. </member>
  59. <member name="process_material" type="Material" setter="set_process_material" getter="get_process_material">
  60. [Material] for processing particles. Can be a [ParticlesMaterial] or a [ShaderMaterial].
  61. </member>
  62. <member name="randomness" type="float" setter="set_randomness_ratio" getter="get_randomness_ratio">
  63. Emission lifetime randomness ratio. Default value: [code]0[/code].
  64. </member>
  65. <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale">
  66. Particle system's running speed scaling ratio. Default value: [code]1[/code]. A value of [code]0[/code] can be used to pause the particles.
  67. </member>
  68. <member name="texture" type="Texture" setter="set_texture" getter="get_texture">
  69. Particle texture. If [code]null[/code] particles will be squares.
  70. </member>
  71. <member name="visibility_rect" type="Rect2" setter="set_visibility_rect" getter="get_visibility_rect">
  72. Editor visibility helper.
  73. </member>
  74. </members>
  75. <constants>
  76. <constant name="DRAW_ORDER_INDEX" value="0" enum="DrawOrder">
  77. Particles are drawn in the order emitted.
  78. </constant>
  79. <constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder">
  80. Particles are drawn in order of remaining lifetime.
  81. </constant>
  82. </constants>
  83. </class>