Explain parameter usage in GPUParticles3D.xml and GPUParticles2D.xml

Co-Authored-By: A Thousand Ships <[email protected]>
godotengine · Dec 5, 2023 · def5545 · def5545
1 parent d76c1d0
commit def5545
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/doc/classes/GPUParticles2D.xml b/doc/classes/GPUParticles2D.xml
@@ -37,6 +37,7 @@
 			<param index="4" name="flags" type="int" />
 			<description>
 				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].
+				The default ParticleProcessMaterial will overwrite [param color] and use the contents of [param custom] as [code](rotation, age, animation, lifetime)[/code].
 			</description>
 		</method>
 		<method name="restart">

diff --git a/doc/classes/GPUParticles3D.xml b/doc/classes/GPUParticles3D.xml
@@ -35,6 +35,7 @@
 			<param index="4" name="flags" type="int" />
 			<description>
 				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].
+				The default ParticleProcessMaterial will overwrite [param color] and use the contents of [param custom] as [code](rotation, age, animation, lifetime)[/code].
 			</description>
 		</method>
 		<method name="get_draw_pass_mesh" qualifiers="const">