virtualx-engine/doc/classes/PackedColorArray.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PackedColorArray" version="4.0">
	<brief_description>
		A packed [Array] of [Color]s.
	</brief_description>
	<description>
		An [Array] specifically designed to hold [Color]. Packs data tightly, so it saves memory for large array sizes.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="PackedColorArray" qualifiers="constructor">
			<return type="PackedColorArray">
			</return>
			<description>
				Constructs an empty [PackedColorArray].
			</description>
		</method>
		<method name="PackedColorArray" qualifiers="constructor">
			<return type="PackedColorArray">
			</return>
			<argument index="0" name="from" type="PackedColorArray">
			</argument>
			<description>
				Constructs a [PackedColorArray] as a copy of the given [PackedColorArray].
			</description>
		</method>
		<method name="PackedColorArray" qualifiers="constructor">
			<return type="PackedColorArray">
			</return>
			<argument index="0" name="from" type="Array">
			</argument>
			<description>
				Constructs a new [PackedColorArray]. Optionally, you can pass in a generic [Array] that will be converted.
			</description>
		</method>
		<method name="append">
			<return type="bool">
			</return>
			<argument index="0" name="value" type="Color">
			</argument>
			<description>
				Appends an element at the end of the array (alias of [method push_back]).
			</description>
		</method>
		<method name="append_array">
			<return type="void">
			</return>
			<argument index="0" name="array" type="PackedColorArray">
			</argument>
			<description>
				Appends a [PackedColorArray] at the end of this array.
			</description>
		</method>
		<method name="duplicate">
			<return type="PackedColorArray">
			</return>
			<description>
				Creates a copy of the array, and returns it.
			</description>
		</method>
		<method name="has">
			<return type="bool">
			</return>
			<argument index="0" name="value" type="Color">
			</argument>
			<description>
				Returns [code]true[/code] if the array contains [code]value[/code].
			</description>
		</method>
		<method name="insert">
			<return type="int">
			</return>
			<argument index="0" name="at_index" type="int">
			</argument>
			<argument index="1" name="value" type="Color">
			</argument>
			<description>
				Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
			</description>
		</method>
		<method name="invert">
			<return type="void">
			</return>
			<description>
				Reverses the order of the elements in the array.
			</description>
		</method>
		<method name="is_empty">
			<return type="bool">
			</return>
			<description>
				Returns [code]true[/code] if the array is empty.
			</description>
		</method>
		<method name="operator !=" qualifiers="operator">
			<return type="bool">
			</return>
			<argument index="0" name="right" type="PackedColorArray">
			</argument>
			<description>
			</description>
		</method>
		<method name="operator +" qualifiers="operator">
			<return type="PackedColorArray">
			</return>
			<argument index="0" name="right" type="PackedColorArray">
			</argument>
			<description>
			</description>
		</method>
		<method name="operator ==" qualifiers="operator">
			<return type="bool">
			</return>
			<argument index="0" name="right" type="PackedColorArray">
			</argument>
			<description>
			</description>
		</method>
		<method name="operator []" qualifiers="operator">
			<return type="Color">
			</return>
			<argument index="0" name="index" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="push_back">
			<return type="bool">
			</return>
			<argument index="0" name="value" type="Color">
			</argument>
			<description>
				Appends a value to the array.
			</description>
		</method>
		<method name="remove">
			<return type="void">
			</return>
			<argument index="0" name="index" type="int">
			</argument>
			<description>
				Removes an element from the array by index.
			</description>
		</method>
		<method name="resize">
			<return type="int">
			</return>
			<argument index="0" name="new_size" type="int">
			</argument>
			<description>
				Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
			</description>
		</method>
		<method name="set">
			<return type="void">
			</return>
			<argument index="0" name="index" type="int">
			</argument>
			<argument index="1" name="value" type="Color">
			</argument>
			<description>
				Changes the [Color] at the given index.
			</description>
		</method>
		<method name="size">
			<return type="int">
			</return>
			<description>
				Returns the size of the array.
			</description>
		</method>
		<method name="sort">
			<return type="void">
			</return>
			<description>
				Sorts the elements of the array in ascending order.
			</description>
		</method>
		<method name="subarray">
			<return type="PackedColorArray">
			</return>
			<argument index="0" name="from" type="int">
			</argument>
			<argument index="1" name="to" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="to_byte_array">
			<return type="PackedByteArray">
			</return>
			<description>
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>