From 0e7de3a1d9d03526436fef7fcdfa7943c48beb16 Mon Sep 17 00:00:00 2001
From: ProgrammerOnCoffee
<171874668+ProgrammerOnCoffee@users.noreply.github.com>
Date: Tue, 21 Jan 2025 12:17:00 -0500
Subject: [PATCH] Fix incorrect CPUParticles2D documentation
Fixes incorrect documentation for CPUParticles2D.color_initial_ramp
---
doc/classes/CPUParticles2D.xml | 4 ++--
doc/classes/CPUParticles3D.xml | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml
index e52e7274006..7457d7a0bcd 100644
--- a/doc/classes/CPUParticles2D.xml
+++ b/doc/classes/CPUParticles2D.xml
@@ -140,10 +140,10 @@
Each particle's initial color. If [member texture] is defined, it will be multiplied by this color.
- Each particle's initial color will vary along this [GradientTexture1D] (multiplied with [member color]).
+ Each particle's initial color will vary along this [Gradient] (multiplied with [member color]).
- Each particle's color will vary along this [Gradient] (multiplied with [member color]).
+ Each particle's color will vary along this [Gradient] over its lifetime (multiplied with [member color]).
Damping will vary along this [Curve]. Should be a unit [Curve].
diff --git a/doc/classes/CPUParticles3D.xml b/doc/classes/CPUParticles3D.xml
index cf80fecca69..170f684638b 100644
--- a/doc/classes/CPUParticles3D.xml
+++ b/doc/classes/CPUParticles3D.xml
@@ -146,11 +146,11 @@
[b]Note:[/b] [member color] multiplies the particle mesh's vertex colors. To have a visible effect on a [BaseMaterial3D], [member BaseMaterial3D.vertex_color_use_as_albedo] [i]must[/i] be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/code] must be inserted in the shader's [code]fragment()[/code] function. Otherwise, [member color] will have no visible effect.
- Each particle's initial color will vary along this [GradientTexture1D] (multiplied with [member color]).
+ Each particle's initial color will vary along this [Gradient] (multiplied with [member color]).
[b]Note:[/b] [member color_initial_ramp] multiplies the particle mesh's vertex colors. To have a visible effect on a [BaseMaterial3D], [member BaseMaterial3D.vertex_color_use_as_albedo] [i]must[/i] be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/code] must be inserted in the shader's [code]fragment()[/code] function. Otherwise, [member color_initial_ramp] will have no visible effect.
- Each particle's color will vary along this [GradientTexture1D] over its lifetime (multiplied with [member color]).
+ Each particle's color will vary along this [Gradient] over its lifetime (multiplied with [member color]).
[b]Note:[/b] [member color_ramp] multiplies the particle mesh's vertex colors. To have a visible effect on a [BaseMaterial3D], [member BaseMaterial3D.vertex_color_use_as_albedo] [i]must[/i] be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/code] must be inserted in the shader's [code]fragment()[/code] function. Otherwise, [member color_ramp] will have no visible effect.