summaryrefslogtreecommitdiff
path: root/doc/classes/GPUParticles2D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/GPUParticles2D.xml')
-rw-r--r--doc/classes/GPUParticles2D.xml16
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/classes/GPUParticles2D.xml b/doc/classes/GPUParticles2D.xml
index 53894bad87..606d2456c5 100644
--- a/doc/classes/GPUParticles2D.xml
+++ b/doc/classes/GPUParticles2D.xml
@@ -20,13 +20,13 @@
</method>
<method name="emit_particle">
<return type="void" />
- <argument index="0" name="xform" type="Transform2D" />
- <argument index="1" name="velocity" type="Vector2" />
- <argument index="2" name="color" type="Color" />
- <argument index="3" name="custom" type="Color" />
- <argument index="4" name="flags" type="int" />
+ <param index="0" name="xform" type="Transform2D" />
+ <param index="1" name="velocity" type="Vector2" />
+ <param index="2" name="color" type="Color" />
+ <param index="3" name="custom" type="Color" />
+ <param index="4" name="flags" type="int" />
<description>
- Emits a single particle. Whether [code]xform[/code], [code]velocity[/code], [code]color[/code] and [code]custom[/code] are applied depends on the value of [code]flags[/code]. See [enum EmitFlags].
+ Emits a single particle. Whether [param xform], [param velocity], [param color] and [param custom] are applied depends on the value of [param flags]. See [enum EmitFlags].
</description>
</method>
<method name="restart">
@@ -63,8 +63,8 @@
<member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime" default="1.0">
Amount of time each particle will exist.
</member>
- <member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates" default="true">
- If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates.
+ <member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates" default="false">
+ If [code]true[/code], particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the [GPUParticles2D] node (and its parents) when it is moved or rotated. If [code]false[/code], particles use global coordinates; they will not move or rotate along the [GPUParticles2D] node (and its parents) when it is moved or rotated.
</member>
<member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot" default="false">
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.