godot/doc/classes/PackedVector3Array.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PackedVector3Array" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A packed array of [Vector3]s.
	</brief_description>
	<description>
		An array specifically designed to hold [Vector3]. Packs data tightly, so it saves memory for large array sizes.
	</description>
	<tutorials>
	</tutorials>
	<constructors>
		<constructor name="PackedVector3Array">
			<return type="PackedVector3Array" />
			<description>
				Constructs an empty [PackedVector3Array].
			</description>
		</constructor>
		<constructor name="PackedVector3Array">
			<return type="PackedVector3Array" />
			<argument index="0" name="from" type="PackedVector3Array" />
			<description>
				Constructs a [PackedVector3Array] as a copy of the given [PackedVector3Array].
			</description>
		</constructor>
		<constructor name="PackedVector3Array">
			<return type="PackedVector3Array" />
			<argument index="0" name="from" type="Array" />
			<description>
				Constructs a new [PackedVector3Array]. Optionally, you can pass in a generic [Array] that will be converted.
			</description>
		</constructor>
	</constructors>
	<methods>
		<method name="append">
			<return type="bool" />
			<argument index="0" name="value" type="Vector3" />
			<description>
				Appends an element at the end of the array (alias of [method push_back]).
			</description>
		</method>
		<method name="append_array">
			<return type="void" />
			<argument index="0" name="array" type="PackedVector3Array" />
			<description>
				Appends a [PackedVector3Array] at the end of this array.
			</description>
		</method>
		<method name="bsearch">
			<return type="int" />
			<argument index="0" name="value" type="Vector3" />
			<argument index="1" name="before" type="bool" default="true" />
			<description>
				Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array.
				[b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.
			</description>
		</method>
		<method name="duplicate">
			<return type="PackedVector3Array" />
			<description>
				Creates a copy of the array, and returns it.
			</description>
		</method>
		<method name="fill">
			<return type="void" />
			<argument index="0" name="value" type="Vector3" />
			<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="has" qualifiers="const">
			<return type="bool" />
			<argument index="0" name="value" type="Vector3" />
			<description>
				Returns [code]true[/code] if the array contains [code]value[/code].
			</description>
		</method>
		<method name="insert">
			<return type="int" />
			<argument index="0" name="at_index" type="int" />
			<argument index="1" name="value" type="Vector3" />
			<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="is_empty" qualifiers="const">
			<return type="bool" />
			<description>
				Returns [code]true[/code] if the array is empty.
			</description>
		</method>
		<method name="push_back">
			<return type="bool" />
			<argument index="0" name="value" type="Vector3" />
			<description>
				Inserts a [Vector3] at the end.
			</description>
		</method>
		<method name="remove_at">
			<return type="void" />
			<argument index="0" name="index" type="int" />
			<description>
				Removes an element from the array by index.
			</description>
		</method>
		<method name="resize">
			<return type="int" />
			<argument index="0" name="new_size" 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="reverse">
			<return type="void" />
			<description>
				Reverses the order of the elements in the array.
			</description>
		</method>
		<method name="set">
			<return type="void" />
			<argument index="0" name="index" type="int" />
			<argument index="1" name="value" type="Vector3" />
			<description>
				Changes the [Vector3] at the given index.
			</description>
		</method>
		<method name="size" qualifiers="const">
			<return type="int" />
			<description>
				Returns the number of elements in the array.
			</description>
		</method>
		<method name="slice" qualifiers="const">
			<return type="PackedVector3Array" />
			<argument index="0" name="begin" type="int" />
			<argument index="1" name="end" type="int" default="2147483647" />
			<description>
				Returns the slice of the [PackedVector3Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedVector3Array].
				The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]).
				If either [code]begin[/code] or [code]end[/code] are negative, they will be relative to the end of the array (i.e. [code]arr.slice(0, -2)[/code] is a shorthand for [code]arr.slice(0, arr.size() - 2)[/code]).
			</description>
		</method>
		<method name="sort">
			<return type="void" />
			<description>
				Sorts the elements of the array in ascending order.
			</description>
		</method>
		<method name="to_byte_array" qualifiers="const">
			<return type="PackedByteArray" />
			<description>
			</description>
		</method>
	</methods>
	<operators>
		<operator name="operator !=">
			<return type="bool" />
			<argument index="0" name="right" type="PackedVector3Array" />
			<description>
			</description>
		</operator>
		<operator name="operator *">
			<return type="PackedVector3Array" />
			<argument index="0" name="right" type="Transform3D" />
			<description>
			</description>
		</operator>
		<operator name="operator +">
			<return type="PackedVector3Array" />
			<argument index="0" name="right" type="PackedVector3Array" />
			<description>
			</description>
		</operator>
		<operator name="operator ==">
			<return type="bool" />
			<argument index="0" name="right" type="PackedVector3Array" />
			<description>
			</description>
		</operator>
		<operator name="operator []">
			<return type="Vector3" />
			<argument index="0" name="index" type="int" />
			<description>
			</description>
		</operator>
	</operators>
</class>