Generic array datatype.
Generic array, contains several elements of any type, accessible by a numerical index starting at 0. Negative indices can be used to count from the back, like in Python (-1 is the last element, -2 the second to last, etc.). Example:
[codeblock]
var array = ["One", 2, 3, "Four"]
print(array[0]) # One
print(array[2]) # 3
print(array[-1]) # Four
array[2] = "Three"
print(array[-2]) # Three
[/codeblock]
Arrays are always passed by reference.
Construct an array from a [PoolColorArray].
Construct an array from a [PoolVector3Array].
Construct an array from a [PoolVector2Array].
Construct an array from a [PoolStringArray].
Construct an array from a [PoolRealArray].
Construct an array from a [PoolIntArray].
Construct an array from a [PoolByteArray].
Append an element at the end of the array (alias of [method push_back]).
Returns the last element of the array if the array is not empty (size>0).
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 that calling bsearch on an unsorted array results in unexpected behavior.
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 and a custom comparison method. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return true if the first argument is less than the second, and return false otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior.
Clear the array (resize to 0).
Return the amount of times an element is in the array.
Returns a copy of the array.
If [code]deep[/code] is [code]true[/code], a deep copy is be performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If [code]false[/code], a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array.
Return true if the array is empty (size==0).
Remove the first occurrence of a value from the array.
Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed.
Searches the array in reverse order for a value and returns its index or -1 if not found.
Returns the first element of the array if the array is not empty (size>0).
Return true if the array contains given value.
[codeblock]
[ "inside", 7 ].has("inside") == true
[ "inside", 7 ].has("outside") == false
[ "inside", 7 ].has(7) == true
[ "inside", 7 ].has("7") == false
[/codeblock]
Return a hashed integer value representing the array contents.
Insert a new element at a given position in the array. The position must be valid, or at the end of the array ([code]pos == size()[/code]).
Reverse the order of the elements in the array.
Return maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned.
Return minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned.
Remove the last element of the array.
Remove the first element of the array.
Append an element at the end of the array.
Add an element at the beginning of the array.
Remove an element from the array by index.
Resize the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null.
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.
Shuffle the array such that the items will have a random order.
Return the amount of elements in the array.
Sort the array using natural order.
Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise.
[b]Note:[/b] you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior.
[codeblock]
class MyCustomSorter:
static func sort(a, b):
if a[0] < b[0]:
return true
return false
var my_items = [[5, "Potato"], [9, "Rice"], [4, "Tomato"]]
my_items.sort_custom(MyCustomSorter, "sort")
[/codeblock]