virtualx-engine/doc/classes/PoolStringArray.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolStringArray" category="Built-In Types" version="3.1-dev">
	<brief_description>
		String Array.
	</brief_description>
	<description>
		String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="PoolStringArray">
			<return type="PoolStringArray">
			</return>
			<argument index="0" name="from" type="Array">
			</argument>
			<description>
				Create from a generic array.
			</description>
		</method>
		<method name="append">
			<argument index="0" name="string" type="String">
			</argument>
			<description>
				Append 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="PoolStringArray">
			</argument>
			<description>
				Append an [StringArray] at the end of this array.
			</description>
		</method>
		<method name="insert">
			<return type="int">
			</return>
			<argument index="0" name="idx" type="int">
			</argument>
			<argument index="1" name="string" type="String">
			</argument>
			<description>
				Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
			</description>
		</method>
		<method name="invert">
			<description>
				Reverse the order of the elements in the array (so first element will now be the last).
			</description>
		</method>
		<method name="join">
			<return type="String">
			</return>
			<argument index="0" name="delimiter" type="String">
			</argument>
			<description>
				Returns a [String] with each element of the array joined with the delimiter.
			</description>
		</method>
		<method name="push_back">
			<argument index="0" name="string" type="String">
			</argument>
			<description>
				Append a string element at end of the array.
			</description>
		</method>
		<method name="remove">
			<argument index="0" name="idx" type="int">
			</argument>
			<description>
				Remove an element from the array by index.
			</description>
		</method>
		<method name="resize">
			<argument index="0" name="idx" type="int">
			</argument>
			<description>
				Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size.
			</description>
		</method>
		<method name="set">
			<argument index="0" name="idx" type="int">
			</argument>
			<argument index="1" name="string" type="String">
			</argument>
			<description>
				Change the [String] at the given index.
			</description>
		</method>
		<method name="size">
			<return type="int">
			</return>
			<description>
				Return the size of the array.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>