virtualx-engine/doc/classes/PoolColorArray.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolColorArray" version="3.5">
	<brief_description>
		A pooled [Array] of [Color].
	</brief_description>
	<description>
		An [Array] specifically designed to hold [Color]. Optimized for memory usage, does not fragment the memory.
		[b]Note:[/b] This type is passed by value and not by reference.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="PoolColorArray">
			<return type="PoolColorArray" />
			<argument index="0" name="from" type="Array" />
			<description>
				Constructs a new [PoolColorArray]. Optionally, you can pass in a generic [Array] that will be converted.
			</description>
		</method>
		<method name="append">
			<argument index="0" name="color" type="Color" />
			<description>
				Appends an element at the end of the array (alias of [method push_back]).
			</description>
		</method>
		<method name="append_array">
			<argument index="0" name="array" type="PoolColorArray" />
			<description>
				Appends a [PoolColorArray] at the end of this array.
			</description>
		</method>
		<method name="empty">
			<return type="bool" />
			<description>
				Returns [code]true[/code] if the array is empty.
			</description>
		</method>
		<method name="insert">
			<return type="int" />
			<argument index="0" name="idx" type="int" />
			<argument index="1" name="color" type="Color" />
			<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">
			<description>
				Reverses the order of the elements in the array.
			</description>
		</method>
		<method name="push_back">
			<argument index="0" name="color" type="Color" />
			<description>
				Appends a value to the array.
			</description>
		</method>
		<method name="remove">
			<argument index="0" name="idx" type="int" />
			<description>
				Removes an element from the array by index.
			</description>
		</method>
		<method name="resize">
			<argument index="0" name="idx" type="int" />
			<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">
			<argument index="0" name="idx" type="int" />
			<argument index="1" name="color" type="Color" />
			<description>
				Changes the [Color] at the given index.
			</description>
		</method>
		<method name="size">
			<return type="int" />
			<description>
				Returns the size of the array.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>