diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-06-27 16:10:09 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2019-07-04 14:08:16 +0200 |
| commit | 542489a86696cba222711a20e31704a62d4b8fed (patch) | |
| tree | 33cad996a760b77b4538850a9614fa1fc3451548 /doc/classes/CPUParticles.xml | |
| parent | 7b569e91c0c6b84965cad416b8e86dcfdacbcfc4 (diff) | |
DocData: Re-expose parametric setters and getters
Setters and getters have been hidden from the documentation when the matching
properties have been exposed, but some of them are parametric and require the
name or index of a given parameter to be used. So they need to be properly
documented with the type and name of the arguments they take.
For example, CPUParticles' `set_param(Parameter param, float value)`.
Diffstat (limited to 'doc/classes/CPUParticles.xml')
| -rw-r--r-- | doc/classes/CPUParticles.xml | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index 8152a52c86..12e00be04a 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -19,6 +19,38 @@ Sets this node's properties to match a given [Particles] node with an assigned [ParticlesMaterial]. </description> </method> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="param" type="int" enum="CPUParticles.Parameter"> + </argument> + <description> + </description> + </method> + <method name="get_param_curve" qualifiers="const"> + <return type="Curve"> + </return> + <argument index="0" name="param" type="int" enum="CPUParticles.Parameter"> + </argument> + <description> + </description> + </method> + <method name="get_param_randomness" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="param" type="int" enum="CPUParticles.Parameter"> + </argument> + <description> + </description> + </method> + <method name="get_particle_flag" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int" enum="CPUParticles.Flags"> + </argument> + <description> + </description> + </method> <method name="restart"> <return type="void"> </return> @@ -26,6 +58,46 @@ Restarts the particle emitter. </description> </method> + <method name="set_param"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="CPUParticles.Parameter"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_param_curve"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="CPUParticles.Parameter"> + </argument> + <argument index="1" name="curve" type="Curve"> + </argument> + <description> + </description> + </method> + <method name="set_param_randomness"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="CPUParticles.Parameter"> + </argument> + <argument index="1" name="randomness" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_particle_flag"> + <return type="void"> + </return> + <argument index="0" name="flag" type="int" enum="CPUParticles.Flags"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="amount" type="int" setter="set_amount" getter="get_amount" default="8"> |