From 84a3fd9daa8893661867dade7003c761ab188977 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Tue, 12 Jul 2022 19:26:10 +0200 Subject: [PATCH] Document initializing PackedVectorArray/PackedColorArray correctly --- doc/classes/PackedColorArray.xml | 4 ++++ doc/classes/PackedVector2Array.xml | 4 ++++ doc/classes/PackedVector3Array.xml | 4 ++++ 3 files changed, 12 insertions(+) diff --git a/doc/classes/PackedColorArray.xml b/doc/classes/PackedColorArray.xml index 663050e5676..eb5a0edfd67 100644 --- a/doc/classes/PackedColorArray.xml +++ b/doc/classes/PackedColorArray.xml @@ -27,6 +27,10 @@ Constructs a new [PackedColorArray]. Optionally, you can pass in a generic [Array] that will be converted. + [b]Note:[/b] When initializing a [PackedColorArray] with elements, it must be initialized with an [Array] of [Color] values: + [codeblock] + var array = PackedColorArray([Color(0.1, 0.2, 0.3), Color(0.4, 0.5, 0.6)]) + [/codeblock] diff --git a/doc/classes/PackedVector2Array.xml b/doc/classes/PackedVector2Array.xml index 0f74e0d2e5e..a5a5d2f2df0 100644 --- a/doc/classes/PackedVector2Array.xml +++ b/doc/classes/PackedVector2Array.xml @@ -28,6 +28,10 @@ Constructs a new [PackedVector2Array]. Optionally, you can pass in a generic [Array] that will be converted. + [b]Note:[/b] When initializing a [PackedVector2Array] with elements, it must be initialized with an [Array] of [Vector2] values: + [codeblock] + var array = PackedVector2Array([Vector2(12, 34), Vector2(56, 78)]) + [/codeblock] diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml index 9d0fdaa7170..25575497039 100644 --- a/doc/classes/PackedVector3Array.xml +++ b/doc/classes/PackedVector3Array.xml @@ -27,6 +27,10 @@ Constructs a new [PackedVector3Array]. Optionally, you can pass in a generic [Array] that will be converted. + [b]Note:[/b] When initializing a [PackedVector3Array] with elements, it must be initialized with an [Array] of [Vector3] values: + [codeblock] + var array = PackedVector3Array([Vector3(12, 34, 56), Vector3(78, 90, 12)]) + [/codeblock]