stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 20:29:03 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd7d443fb2a2c36ce53852ed86ebf56513ca78cd
godot-docs/classes/class_particles2d.rst
T

302 lines
18 KiB
ReStructuredText
Raw Blame History

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_Particles2D:
Particles2D
===========
**Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
2D Particle emitter
Member Functions
----------------
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`capture_rect<class_Particles2D_capture_rect>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_amount<class_Particles2D_get_amount>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_draw_order<class_Particles2D_get_draw_order>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_explosiveness_ratio<class_Particles2D_get_explosiveness_ratio>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_fixed_fps<class_Particles2D_get_fixed_fps>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_fractional_delta<class_Particles2D_get_fractional_delta>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_h_frames<class_Particles2D_get_h_frames>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_lifetime<class_Particles2D_get_lifetime>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_normal_map<class_Particles2D_get_normal_map>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_one_shot<class_Particles2D_get_one_shot>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pre_process_time<class_Particles2D_get_pre_process_time>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Material<class_material>` | :ref:`get_process_material<class_Particles2D_get_process_material>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_randomness_ratio<class_Particles2D_get_randomness_ratio>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_speed_scale<class_Particles2D_get_speed_scale>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_Particles2D_get_texture>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_use_local_coordinates<class_Particles2D_get_use_local_coordinates>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_v_frames<class_Particles2D_get_v_frames>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_visibility_rect<class_Particles2D_get_visibility_rect>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_emitting<class_Particles2D_is_emitting>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`restart<class_Particles2D_restart>` **(** **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_amount<class_Particles2D_set_amount>` **(** :ref:`int<class_int>` amount **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_draw_order<class_Particles2D_set_draw_order>` **(** :ref:`int<class_int>` order **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_emitting<class_Particles2D_set_emitting>` **(** :ref:`bool<class_bool>` emitting **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_explosiveness_ratio<class_Particles2D_set_explosiveness_ratio>` **(** :ref:`float<class_float>` ratio **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_fixed_fps<class_Particles2D_set_fixed_fps>` **(** :ref:`int<class_int>` fps **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_fractional_delta<class_Particles2D_set_fractional_delta>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_h_frames<class_Particles2D_set_h_frames>` **(** :ref:`int<class_int>` frames **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_lifetime<class_Particles2D_set_lifetime>` **(** :ref:`float<class_float>` secs **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_normal_map<class_Particles2D_set_normal_map>` **(** :ref:`Texture<class_texture>` texture **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_one_shot<class_Particles2D_set_one_shot>` **(** :ref:`bool<class_bool>` secs **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pre_process_time<class_Particles2D_set_pre_process_time>` **(** :ref:`float<class_float>` secs **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_process_material<class_Particles2D_set_process_material>` **(** :ref:`Material<class_material>` material **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_randomness_ratio<class_Particles2D_set_randomness_ratio>` **(** :ref:`float<class_float>` ratio **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_speed_scale<class_Particles2D_set_speed_scale>` **(** :ref:`float<class_float>` scale **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture<class_Particles2D_set_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_local_coordinates<class_Particles2D_set_use_local_coordinates>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_v_frames<class_Particles2D_set_v_frames>` **(** :ref:`int<class_int>` frames **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_visibility_rect<class_Particles2D_set_visibility_rect>` **(** :ref:`Rect2<class_rect2>` aabb **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **amount**
- :ref:`int<class_int>` **draw_order**
- :ref:`bool<class_bool>` **emitting**
- :ref:`float<class_float>` **explosiveness**
- :ref:`int<class_int>` **fixed_fps**
- :ref:`bool<class_bool>` **fract_delta**
- :ref:`int<class_int>` **h_frames**
- :ref:`float<class_float>` **lifetime**
- :ref:`bool<class_bool>` **local_coords**
- :ref:`Texture<class_texture>` **normal_map**
- :ref:`bool<class_bool>` **one_shot**
- :ref:`float<class_float>` **preprocess**
- ShaderMaterial,ParticlesMaterial **process_material**
- :ref:`float<class_float>` **randomness**
- :ref:`float<class_float>` **speed_scale**
- :ref:`Texture<class_texture>` **texture**
- :ref:`int<class_int>` **v_frames**
- :ref:`Rect3<class_rect3>` **visibility_rect**
Numeric Constants
-----------------
- **DRAW_ORDER_INDEX** = **0**
- **DRAW_ORDER_LIFETIME** = **1**
Description
-----------
Particles2D is a particle system 2D :ref:`Node<class_node>` that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility bounding box (although helpers to create one automatically exist).
Member Function Description
---------------------------
.. _class_Particles2D_capture_rect:
- :ref:`Rect2<class_rect2>` **capture_rect** **(** **)** const
.. _class_Particles2D_get_amount:
- :ref:`int<class_int>` **get_amount** **(** **)** const
Returns the amount of particles spawned at each emission
.. _class_Particles2D_get_draw_order:
- :ref:`int<class_int>` **get_draw_order** **(** **)** const
.. _class_Particles2D_get_explosiveness_ratio:
- :ref:`float<class_float>` **get_explosiveness_ratio** **(** **)** const
.. _class_Particles2D_get_fixed_fps:
- :ref:`int<class_int>` **get_fixed_fps** **(** **)** const
.. _class_Particles2D_get_fractional_delta:
- :ref:`bool<class_bool>` **get_fractional_delta** **(** **)** const
.. _class_Particles2D_get_h_frames:
- :ref:`int<class_int>` **get_h_frames** **(** **)** const
.. _class_Particles2D_get_lifetime:
- :ref:`float<class_float>` **get_lifetime** **(** **)** const
Gets the amount of seconds that each particle will be visible.
.. _class_Particles2D_get_normal_map:
- :ref:`Texture<class_texture>` **get_normal_map** **(** **)** const
.. _class_Particles2D_get_one_shot:
- :ref:`bool<class_bool>` **get_one_shot** **(** **)** const
.. _class_Particles2D_get_pre_process_time:
- :ref:`float<class_float>` **get_pre_process_time** **(** **)** const
.. _class_Particles2D_get_process_material:
- :ref:`Material<class_material>` **get_process_material** **(** **)** const
.. _class_Particles2D_get_randomness_ratio:
- :ref:`float<class_float>` **get_randomness_ratio** **(** **)** const
.. _class_Particles2D_get_speed_scale:
- :ref:`float<class_float>` **get_speed_scale** **(** **)** const
.. _class_Particles2D_get_texture:
- :ref:`Texture<class_texture>` **get_texture** **(** **)** const
Returns the texture for emitted particles
.. _class_Particles2D_get_use_local_coordinates:
- :ref:`bool<class_bool>` **get_use_local_coordinates** **(** **)** const
.. _class_Particles2D_get_v_frames:
- :ref:`int<class_int>` **get_v_frames** **(** **)** const
.. _class_Particles2D_get_visibility_rect:
- :ref:`Rect2<class_rect2>` **get_visibility_rect** **(** **)** const
.. _class_Particles2D_is_emitting:
- :ref:`bool<class_bool>` **is_emitting** **(** **)** const
Returns whether this emitter is currently emitting or not
.. _class_Particles2D_restart:
- void **restart** **(** **)**
.. _class_Particles2D_set_amount:
- void **set_amount** **(** :ref:`int<class_int>` amount **)**
Sets the amount of particles spawned at each emission
.. _class_Particles2D_set_draw_order:
- void **set_draw_order** **(** :ref:`int<class_int>` order **)**
.. _class_Particles2D_set_emitting:
- void **set_emitting** **(** :ref:`bool<class_bool>` emitting **)**
If this is set to true then the particle emitter will emit particles, if its false it will not.
.. _class_Particles2D_set_explosiveness_ratio:
- void **set_explosiveness_ratio** **(** :ref:`float<class_float>` ratio **)**
.. _class_Particles2D_set_fixed_fps:
- void **set_fixed_fps** **(** :ref:`int<class_int>` fps **)**
.. _class_Particles2D_set_fractional_delta:
- void **set_fractional_delta** **(** :ref:`bool<class_bool>` enable **)**
.. _class_Particles2D_set_h_frames:
- void **set_h_frames** **(** :ref:`int<class_int>` frames **)**
.. _class_Particles2D_set_lifetime:
- void **set_lifetime** **(** :ref:`float<class_float>` secs **)**
Sets the amount of seconds that each particle will be visible.
.. _class_Particles2D_set_normal_map:
- void **set_normal_map** **(** :ref:`Texture<class_texture>` texture **)**
.. _class_Particles2D_set_one_shot:
- void **set_one_shot** **(** :ref:`bool<class_bool>` secs **)**
.. _class_Particles2D_set_pre_process_time:
- void **set_pre_process_time** **(** :ref:`float<class_float>` secs **)**
.. _class_Particles2D_set_process_material:
- void **set_process_material** **(** :ref:`Material<class_material>` material **)**
.. _class_Particles2D_set_randomness_ratio:
- void **set_randomness_ratio** **(** :ref:`float<class_float>` ratio **)**
.. _class_Particles2D_set_speed_scale:
- void **set_speed_scale** **(** :ref:`float<class_float>` scale **)**
.. _class_Particles2D_set_texture:
- void **set_texture** **(** :ref:`Texture<class_texture>` texture **)**
.. _class_Particles2D_set_use_local_coordinates:
- void **set_use_local_coordinates** **(** :ref:`bool<class_bool>` enable **)**
.. _class_Particles2D_set_v_frames:
- void **set_v_frames** **(** :ref:`int<class_int>` frames **)**
.. _class_Particles2D_set_visibility_rect:
- void **set_visibility_rect** **(** :ref:`Rect2<class_rect2>` aabb **)**
Reference in New Issue View Git Blame Copy Permalink