pandemonium_engine_minimal/doc/classes/PoolRealArray.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolRealArray" version="4.2">
	<brief_description>
		A pooled Array of real numbers ([float]).
	</brief_description>
	<description>
		An Array specifically designed to hold floating-point values. Optimized for memory usage, does not fragment the memory.
		[b]Note:[/b] This type is passed by value and not by reference. This means that when [i]mutating[/i] a class property of type [PoolRealArray] or mutating a [PoolRealArray] within an [Array] or [Dictionary], changes will be lost:
		[codeblock]
		var array = [PoolRealArray()]
		array[0].push_back(12.34)
		print(array)  # [[]] (empty PoolRealArray within an Array)
		[/codeblock]
		Instead, the entire [PoolRealArray] property must be [i]reassigned[/i] with [code]=[/code] for it to be changed:
		[codeblock]
		var array = [PoolRealArray()]
		var pool_array = array[0]
		pool_array.push_back(12.34)
		array[0] = pool_array
		print(array)  # [[12.34]] (PoolRealArray with 1 element inside an Array)
		[/codeblock]
		[b]Note:[/b] Unlike primitive [float]s which are 64-bit, numbers stored in [PoolRealArray] are 32-bit floats. This means values stored in [PoolRealArray] have lower precision compared to primitive [float]s. If you need to store 64-bit floats in an array, use a generic Array with [float] elements as these will still be 64-bit. However, using a generic Array to store [float]s will use roughly 6 times more memory compared to a [PoolRealArray].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="PoolRealArray">
			<return type="PoolRealArray" />
			<argument index="0" name="from" type="Array" />
			<description>
				Constructs a new [PoolRealArray]. Optionally, you can pass in a generic Array that will be converted.
			</description>
		</method>
		<method name="append">
			<argument index="0" name="value" type="float" />
			<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="PoolRealArray" />
			<description>
				Appends a [PoolRealArray] at the end of this array.
			</description>
		</method>
		<method name="clear">
			<description>
			</description>
		</method>
		<method name="contains">
			<return type="bool" />
			<argument index="0" name="value" type="float" />
			<description>
			</description>
		</method>
		<method name="count">
			<return type="int" />
			<argument index="0" name="value" type="float" />
			<description>
				Returns the number of times an element is in the array.
			</description>
		</method>
		<method name="empty">
			<return type="bool" />
			<description>
				Returns [code]true[/code] if the array is empty.
			</description>
		</method>
		<method name="fill">
			<argument index="0" name="value" type="float" />
			<description>
				Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
			</description>
		</method>
		<method name="find">
			<return type="int" />
			<argument index="0" name="value" type="float" />
			<argument index="1" name="from" type="int" default="0" />
			<description>
				Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. Returns [code]-1[/code] if [code]from[/code] is out of bounds.
			</description>
		</method>
		<method name="has">
			<return type="bool" />
			<argument index="0" name="value" type="float" />
			<description>
				Returns [code]true[/code] if the array contains the given value.
				[b]Note:[/b] This is equivalent to using the [code]in[/code] operator.
			</description>
		</method>
		<method name="insert">
			<return type="int" />
			<argument index="0" name="idx" type="int" />
			<argument index="1" name="value" type="float" />
			<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="value" type="float" />
			<description>
				Appends an element at the end of 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.
				[b]Note:[/b] Added elements are not automatically initialized to 0 and will contain garbage, i.e. indeterminate values.
			</description>
		</method>
		<method name="rfind">
			<return type="int" />
			<argument index="0" name="value" type="float" />
			<argument index="1" name="from" type="int" default="-1" />
			<description>
				Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. If the adjusted start index is out of bounds, this method searches from the end of the array.
			</description>
		</method>
		<method name="set">
			<argument index="0" name="idx" type="int" />
			<argument index="1" name="value" type="float" />
			<description>
				Changes the float at the given index.
			</description>
		</method>
		<method name="size">
			<return type="int" />
			<description>
				Returns the number of elements in the array.
			</description>
		</method>
		<method name="sort">
			<description>
				Sorts the elements of the array in ascending order.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>