asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #25059 from TheCoderNextdoor/TheCoderNextdoor-patch-1

Browse source 
doc: Add missing descriptions to Particles2D
This commit is contained in:
Rémi Verschelde 2019-01-19 10:18:58 +01:00 committed by GitHub
commit 7f9209781c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/classes/Particles2D.xml
View file

@ -16,12 +16,14 @@
<return type="Rect2"> <return type="Rect2">
</return> </return>
<description> <description>
Returns a rectangle containing the positions of all existing particles.
</description> </description>
</method> </method>
<method name="restart"> <method name="restart">
<return type="void"> <return type="void">
</return> </return>
<description> <description>
Restarts all the existing particles.
</description> </description>
</method> </method>
</methods> </methods>
@ -39,8 +41,10 @@
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]. 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].
</member> </member>
<member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps"> <member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps">
The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the particle system itself.
</member> </member>
<member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta"> <member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta">
If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code]
</member> </member>
<member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime"> <member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime">
Amount of time each particle will exist. Default value: [code]1[/code]. Amount of time each particle will exist. Default value: [code]1[/code].
@ -49,6 +53,7 @@
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]. 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].
</member> </member>
<member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map"> <member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map">
Normal map to be used for the [code]texture[/code] property.
</member> </member>
<member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot"> <member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot">
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]. 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].