diff options
author | kobewi <kobewi4e@gmail.com> | 2022-08-17 00:18:22 +0200 |
---|---|---|
committer | kobewi <kobewi4e@gmail.com> | 2022-08-19 00:43:29 +0200 |
commit | b099a8570cf42e9108f914a11e8e1f63c5ce8729 (patch) | |
tree | 110433a7a629d0d09256f079780ed181ee2116e8 /doc/classes/PackedColorArray.xml | |
parent | 17ca5b913c0a1fdad120a0451bd8183a2c6927ef (diff) | |
download | redot-engine-b099a8570cf42e9108f914a11e8e1f63c5ce8729.tar.gz |
Complete documentation of packed arrays
Diffstat (limited to 'doc/classes/PackedColorArray.xml')
-rw-r--r-- | doc/classes/PackedColorArray.xml | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/classes/PackedColorArray.xml b/doc/classes/PackedColorArray.xml index c694927175..a2dc8e8f1d 100644 --- a/doc/classes/PackedColorArray.xml +++ b/doc/classes/PackedColorArray.xml @@ -177,6 +177,7 @@ <method name="to_byte_array" qualifiers="const"> <return type="PackedByteArray" /> <description> + Returns a [PackedByteArray] with each color encoded as bytes. </description> </method> </methods> @@ -185,24 +186,28 @@ <return type="bool" /> <param index="0" name="right" type="PackedColorArray" /> <description> + Returns [code]true[/code] if contents of the arrays differ. </description> </operator> <operator name="operator +"> <return type="PackedColorArray" /> <param index="0" name="right" type="PackedColorArray" /> <description> + Returns a new [PackedColorArray] with contents of [param right] added at the end of this array. For better performance, consider using [method append_array] instead. </description> </operator> <operator name="operator =="> <return type="bool" /> <param index="0" name="right" type="PackedColorArray" /> <description> + Returns [code]true[/code] if contents of both arrays are the same, i.e. they have all equal [Color]s at the corresponding indices. </description> </operator> <operator name="operator []"> <return type="Color" /> <param index="0" name="index" type="int" /> <description> + Returns the [Color] at index [param index]. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. </description> </operator> </operators> |