Index · PackedVector3Array

PackedVector3Array

A packed array of Vector3s.

Class Description

An array specifically designed to hold Vector3. Packs data tightly, so it saves memory for large array sizes.

Differences between packed arrays, typed arrays, and untyped arrays: Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g. PackedVector3Array versus Array[Vector3]). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such as Array.map(). Typed arrays are in turn faster to iterate on and modify than untyped arrays.

Note: Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use duplicate(). This is not the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will not affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again.

Note: In a boolean context, a packed array will evaluate to false if it's empty. Otherwise, a packed array will always evaluate to true.

Methods

func append(value: Vector3) -> bool

Appends an element at the end of the array (alias of push_back()).

func append_array(array: PackedVector3Array) -> void

Appends a PackedVector3Array at the end of this array.

func bsearch(value: Vector3, before: bool = true) -> int

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 before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array.

Note: Calling bsearch() on an unsorted array results in unexpected behavior.

Note: Vectors with NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.

func clear() -> void

Clears the array. This is equivalent to using resize() with a size of 0.

func count(value: Vector3) -> int

Returns the number of times an element is in the array.

Note: Vectors with NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.

func duplicate() -> PackedVector3Array

Creates a copy of the array, and returns it.

func erase(value: Vector3) -> bool

Removes the first occurrence of a value from the array and returns true. If the value does not exist in the array, nothing happens and false is returned. To remove an element by index, use remove_at() instead.

Note: Vectors with NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.

func fill(value: Vector3) -> void

Assigns the given value to all elements in the array. This can typically be used together with resize() to create an array with a given size and initialized elements.

func find(value: Vector3, from: int = 0) -> int

Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed.

Note: Vectors with NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.

func get(index: int) -> Vector3

Returns the Vector3 at the given index in the array. If index is out-of-bounds or negative, this method fails and returns Vector3(0, 0, 0).

This method is similar (but not identical) to the [] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.

func has(value: Vector3) -> bool

Returns true if the array contains value.

Note: Vectors with NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.

func insert(at_index: int, value: Vector3) -> int

Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (idx == size()).

func is_empty() -> bool

Returns true if the array is empty.

func push_back(value: Vector3) -> bool

Inserts a Vector3 at the end.

func remove_at(index: int) -> void

Removes an element from the array by index.

func resize(new_size: int) -> int

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. Calling resize() once and assigning the new values is faster than adding new elements one by one.

Returns OK on success, or one of the following Error constants if this method fails: ERR_INVALID_PARAMETER if the size is negative, or ERR_OUT_OF_MEMORY if allocations fail. Use size() to find the actual size of the array after resize.

func reverse() -> void

Reverses the order of the elements in the array.

func rfind(value: Vector3, from: int = -1) -> int

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.

Note: Vectors with NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.

func set(index: int, value: Vector3) -> void

Changes the Vector3 at the given index.

func size() -> int

Returns the number of elements in the array.

func slice(begin: int, end: int = 2147483647) -> PackedVector3Array

Returns the slice of the PackedVector3Array, from begin (inclusive) to end (exclusive), as a new PackedVector3Array.

The absolute value of begin and end will be clamped to the array size, so the default value for end makes it slice to the size of the array by default (i.e. arr.slice(1) is a shorthand for arr.slice(1, arr.size())).

If either begin or end are negative, they will be relative to the end of the array (i.e. arr.slice(0, -2) is a shorthand for arr.slice(0, arr.size() - 2)).

func sort() -> void

Sorts the elements of the array in ascending order.

Note: Vectors with NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.

func to_byte_array() -> PackedByteArray

Returns a PackedByteArray with each vector encoded as bytes.