summaryrefslogtreecommitdiff
path: root/doc/classes/ParticlesMaterial.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/ParticlesMaterial.xml')
-rw-r--r--doc/classes/ParticlesMaterial.xml15
1 files changed, 13 insertions, 2 deletions
diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml
index 64751cdf76..fd3a448182 100644
--- a/doc/classes/ParticlesMaterial.xml
+++ b/doc/classes/ParticlesMaterial.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="ParticlesMaterial" inherits="Material" category="Core" version="3.2">
+<class name="ParticlesMaterial" inherits="Material" version="3.2">
<brief_description>
Particle properties for [Particles] and [Particles2D] nodes.
</brief_description>
@@ -17,6 +17,7 @@
<argument index="0" name="flag" type="int" enum="ParticlesMaterial.Flags">
</argument>
<description>
+ Returns [code]true[/code] if the specified flag is enabled.
</description>
</method>
<method name="get_param" qualifiers="const">
@@ -25,6 +26,7 @@
<argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter">
</argument>
<description>
+ Returns the value of the specified parameter.
</description>
</method>
<method name="get_param_randomness" qualifiers="const">
@@ -33,6 +35,7 @@
<argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter">
</argument>
<description>
+ Returns the randomness ratio associated with the specified parameter.
</description>
</method>
<method name="get_param_texture" qualifiers="const">
@@ -41,6 +44,7 @@
<argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter">
</argument>
<description>
+ Returns the [Texture] used by the specified parameter.
</description>
</method>
<method name="set_flag">
@@ -51,6 +55,7 @@
<argument index="1" name="enable" type="bool">
</argument>
<description>
+ If [code]true[/code], enables the specified flag. See [enum Flags] for options.
</description>
</method>
<method name="set_param">
@@ -61,6 +66,7 @@
<argument index="1" name="value" type="float">
</argument>
<description>
+ Sets the specified [enum Parameter].
</description>
</method>
<method name="set_param_randomness">
@@ -71,6 +77,7 @@
<argument index="1" name="randomness" type="float">
</argument>
<description>
+ Sets the randomness ratio for the specified [enum Parameter].
</description>
</method>
<method name="set_param_texture">
@@ -81,6 +88,7 @@
<argument index="1" name="texture" type="Texture">
</argument>
<description>
+ Sets the [Texture] for the specified [enum Parameter].
</description>
</method>
</methods>
@@ -157,7 +165,7 @@
Particles will be emitted at positions determined by sampling this texture at a random position. Used with [constant EMISSION_SHAPE_POINTS] and [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.
</member>
<member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="ParticlesMaterial.EmissionShape" default="0">
- Particles will be emitted inside this region. Use [code]EMISSION_SHAPE_*[/code] constants for values.
+ Particles will be emitted inside this region. Use [enum EmissionShape] constants for values.
</member>
<member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius">
The sphere's radius if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_SPHERE].
@@ -321,5 +329,8 @@
<constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape">
Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle velocity and rotation will be set based on [member emission_normal_texture]. Particle color will be modulated by [member emission_color_texture].
</constant>
+ <constant name="EMISSION_SHAPE_MAX" value="5" enum="EmissionShape">
+ Represents the size of the [enum EmissionShape] enum.
+ </constant>
</constants>
</class>