virtualx-engine/doc/classes/PackedInt32Array.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PackedInt32Array" version="4.0">
	<brief_description>
		A packed [Array] of 32-bit integers.
	</brief_description>
	<description>
		An [Array] specifically designed to hold 32-bit integer values. Packs data tightly, so it saves memory for large array sizes.
		[b]Note:[/b] This type stores signed 32-bit integers, which means it can take values in the interval [code][-2^31, 2^31 - 1][/code], i.e. [code][-2147483648, 2147483647][/code]. Exceeding those bounds will wrap around. In comparison, [int] uses signed 64-bit integers which can hold much larger values. If you need to pack 64-bit integers tightly, see [PackedInt64Array].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="PackedInt32Array" qualifiers="constructor">
			<return type="PackedInt32Array">
			</return>
			<description>
				Constructs an empty [PackedInt32Array].
			</description>
		</method>
		<method name="PackedInt32Array" qualifiers="constructor">
			<return type="PackedInt32Array">
			</return>
			<argument index="0" name="from" type="PackedInt32Array">
			</argument>
			<description>
				Constructs a [PackedInt32Array] as a copy of the given [PackedInt32Array].
			</description>
		</method>
		<method name="PackedInt32Array" qualifiers="constructor">
			<return type="PackedInt32Array">
			</return>
			<argument index="0" name="from" type="Array">
			</argument>
			<description>
				Constructs a new [PackedInt32Array]. 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="int">
			</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="PackedInt32Array">
			</argument>
			<description>
				Appends a [PackedInt32Array] at the end of this array.
			</description>
		</method>
		<method name="duplicate">
			<return type="PackedInt32Array">
			</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="int">
			</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="int">
			</argument>
			<description>
				Inserts a new integer 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="is_empty" qualifiers="const">
			<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="PackedInt32Array">
			</argument>
			<description>
			</description>
		</method>
		<method name="operator +" qualifiers="operator">
			<return type="PackedInt32Array">
			</return>
			<argument index="0" name="right" type="PackedInt32Array">
			</argument>
			<description>
			</description>
		</method>
		<method name="operator ==" qualifiers="operator">
			<return type="bool">
			</return>
			<argument index="0" name="right" type="PackedInt32Array">
			</argument>
			<description>
			</description>
		</method>
		<method name="operator []" qualifiers="operator">
			<return type="int">
			</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="int">
			</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="reverse">
			<return type="void">
			</return>
			<description>
				Reverses the order of the elements in the array.
			</description>
		</method>
		<method name="set">
			<return type="void">
			</return>
			<argument index="0" name="index" type="int">
			</argument>
			<argument index="1" name="value" type="int">
			</argument>
			<description>
				Changes the integer at the given index.
			</description>
		</method>
		<method name="size" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the array size.
			</description>
		</method>
		<method name="sort">
			<return type="void">
			</return>
			<description>
				Sorts the elements of the array in ascending order.
			</description>
		</method>
		<method name="subarray" qualifiers="const">
			<return type="PackedInt32Array">
			</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" qualifiers="const">
			<return type="PackedByteArray">
			</return>
			<description>
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>