From 9a9a164e7d3634389fba539a629790b6f69140b0 Mon Sep 17 00:00:00 2001
From: Ninni Pipping <over999ships@gmail.com>
Date: Mon, 3 Jul 2023 10:47:34 +0200
Subject: Clarify that `Gradient.colors/offsets` are returned by-copy

---
 doc/classes/Gradient.xml | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'doc/classes/Gradient.xml')

diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml
index f76ccb49ac..dce964e509 100644
--- a/doc/classes/Gradient.xml
+++ b/doc/classes/Gradient.xml
@@ -79,6 +79,7 @@
 	<members>
 		<member name="colors" type="PackedColorArray" setter="set_colors" getter="get_colors" default="PackedColorArray(0, 0, 0, 1, 1, 1, 1, 1)">
 			Gradient's colors returned as a [PackedColorArray].
+			[b]Note:[/b] This property returns a copy, modifying the return value does not update the gradient. To update the gradient use [method set_color] method (for updating colors individually) or assign to this property directly (for bulk-updating all colors at once).
 		</member>
 		<member name="interpolation_color_space" type="int" setter="set_interpolation_color_space" getter="get_interpolation_color_space" enum="Gradient.ColorSpace" default="0">
 			The color space used to interpolate between points of the gradient. It does not affect the returned colors, which will always be in sRGB space. See [enum ColorSpace] for available modes.
@@ -89,6 +90,7 @@
 		</member>
 		<member name="offsets" type="PackedFloat32Array" setter="set_offsets" getter="get_offsets" default="PackedFloat32Array(0, 1)">
 			Gradient's offsets returned as a [PackedFloat32Array].
+			[b]Note:[/b] This property returns a copy, modifying the return value does not update the gradient. To update the gradient use [method set_offset] method (for updating offsets individually) or assign to this property directly (for bulk-updating all offsets at once).
 		</member>
 	</members>
 	<constants>
-- 
cgit v1.2.3