summaryrefslogtreecommitdiff
path: root/doc/classes/Particles2D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Particles2D.xml')
-rw-r--r--doc/classes/Particles2D.xml265
1 files changed, 3 insertions, 262 deletions
diff --git a/doc/classes/Particles2D.xml b/doc/classes/Particles2D.xml
index be69e03d56..8b908a1fa2 100644
--- a/doc/classes/Particles2D.xml
+++ b/doc/classes/Particles2D.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="Particles2D" inherits="Node2D" category="Core" version="3.0-alpha">
+<class name="Particles2D" inherits="Node2D" category="Core" version="3.0-beta">
<brief_description>
2D particle emitter.
</brief_description>
@@ -18,271 +18,12 @@
<description>
</description>
</method>
- <method name="get_amount" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the amount of particles spawned at each emission
- </description>
- </method>
- <method name="get_draw_order" qualifiers="const">
- <return type="int" enum="Particles2D.DrawOrder">
- </return>
- <description>
- </description>
- </method>
- <method name="get_explosiveness_ratio" qualifiers="const">
- <return type="float">
- </return>
- <description>
- </description>
- </method>
- <method name="get_fixed_fps" qualifiers="const">
- <return type="int">
- </return>
- <description>
- </description>
- </method>
- <method name="get_fractional_delta" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- </description>
- </method>
- <method name="get_h_frames" qualifiers="const">
- <return type="int">
- </return>
- <description>
- </description>
- </method>
- <method name="get_lifetime" qualifiers="const">
- <return type="float">
- </return>
- <description>
- Gets the amount of seconds that each particle will be visible.
- </description>
- </method>
- <method name="get_normal_map" qualifiers="const">
- <return type="Texture">
- </return>
- <description>
- </description>
- </method>
- <method name="get_one_shot" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- </description>
- </method>
- <method name="get_pre_process_time" qualifiers="const">
- <return type="float">
- </return>
- <description>
- </description>
- </method>
- <method name="get_process_material" qualifiers="const">
- <return type="Material">
- </return>
- <description>
- </description>
- </method>
- <method name="get_randomness_ratio" qualifiers="const">
- <return type="float">
- </return>
- <description>
- </description>
- </method>
- <method name="get_speed_scale" qualifiers="const">
- <return type="float">
- </return>
- <description>
- </description>
- </method>
- <method name="get_texture" qualifiers="const">
- <return type="Texture">
- </return>
- <description>
- Returns the texture for emitted particles
- </description>
- </method>
- <method name="get_use_local_coordinates" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- </description>
- </method>
- <method name="get_v_frames" qualifiers="const">
- <return type="int">
- </return>
- <description>
- </description>
- </method>
- <method name="get_visibility_rect" qualifiers="const">
- <return type="Rect2">
- </return>
- <description>
- </description>
- </method>
- <method name="is_emitting" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns whether this emitter is currently emitting or not
- </description>
- </method>
<method name="restart">
<return type="void">
</return>
<description>
</description>
</method>
- <method name="set_amount">
- <return type="void">
- </return>
- <argument index="0" name="amount" type="int">
- </argument>
- <description>
- Sets the amount of particles spawned at each emission
- </description>
- </method>
- <method name="set_draw_order">
- <return type="void">
- </return>
- <argument index="0" name="order" type="int" enum="Particles2D.DrawOrder">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_emitting">
- <return type="void">
- </return>
- <argument index="0" name="emitting" type="bool">
- </argument>
- <description>
- If this is set to true then the particle emitter will emit particles, if its false it will not.
- </description>
- </method>
- <method name="set_explosiveness_ratio">
- <return type="void">
- </return>
- <argument index="0" name="ratio" type="float">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_fixed_fps">
- <return type="void">
- </return>
- <argument index="0" name="fps" type="int">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_fractional_delta">
- <return type="void">
- </return>
- <argument index="0" name="enable" type="bool">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_h_frames">
- <return type="void">
- </return>
- <argument index="0" name="frames" type="int">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_lifetime">
- <return type="void">
- </return>
- <argument index="0" name="secs" type="float">
- </argument>
- <description>
- Sets the amount of seconds that each particle will be visible.
- </description>
- </method>
- <method name="set_normal_map">
- <return type="void">
- </return>
- <argument index="0" name="texture" type="Texture">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_one_shot">
- <return type="void">
- </return>
- <argument index="0" name="secs" type="bool">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_pre_process_time">
- <return type="void">
- </return>
- <argument index="0" name="secs" type="float">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_process_material">
- <return type="void">
- </return>
- <argument index="0" name="material" type="Material">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_randomness_ratio">
- <return type="void">
- </return>
- <argument index="0" name="ratio" type="float">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_speed_scale">
- <return type="void">
- </return>
- <argument index="0" name="scale" type="float">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_texture">
- <return type="void">
- </return>
- <argument index="0" name="texture" type="Texture">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_use_local_coordinates">
- <return type="void">
- </return>
- <argument index="0" name="enable" type="bool">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_v_frames">
- <return type="void">
- </return>
- <argument index="0" name="frames" type="int">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_visibility_rect">
- <return type="void">
- </return>
- <argument index="0" name="aabb" type="Rect2">
- </argument>
- <description>
- </description>
- </method>
</methods>
<members>
<member name="amount" type="int" setter="set_amount" getter="get_amount">
@@ -338,10 +79,10 @@
</member>
</members>
<constants>
- <constant name="DRAW_ORDER_INDEX" value="0">
+ <constant name="DRAW_ORDER_INDEX" value="0" enum="DrawOrder">
Particles are drawn in the order emitted.
</constant>
- <constant name="DRAW_ORDER_LIFETIME" value="1">
+ <constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder">
Particles are drawn in order of remaining lifetime.
</constant>
</constants>
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-13 21:00:34 +0000