W3cubDocs

/Godot 3.0

Array

Category: Built-In Types

Brief Description

Generic array datatype.

Member Functions

Array Array ( PoolColorArray from )
Array Array ( PoolVector3Array from )
Array Array ( PoolVector2Array from )
Array Array ( PoolStringArray from )
Array Array ( PoolRealArray from )
Array Array ( PoolIntArray from )
Array Array ( PoolByteArray from )
void append ( var value )
var back ( )
int bsearch ( var value, bool before=True )
int bsearch_custom ( var value, Object obj, String func, bool before=True )
void clear ( )
int count ( var value )
Array duplicate ( )
bool empty ( )
void erase ( var value )
int find ( var what, int from=0 )
int find_last ( var value )
var front ( )
bool has ( var value )
int hash ( )
void insert ( int position, var value )
void invert ( )
var pop_back ( )
var pop_front ( )
void push_back ( var value )
void push_front ( var value )
void remove ( int position )
void resize ( int size )
int rfind ( var what, int from=-1 )
int size ( )
void sort ( )
void sort_custom ( Object obj, String func )

Description

Generic array, contains several elements of any type, accessible by numerical index starting at 0. Negative indices can be used to count from the right, like in Python. Arrays are always passed by reference.

Member Function Description

Array Array ( PoolColorArray from )

Construct an array from a PoolColorArray.

Array Array ( PoolVector3Array from )

Construct an array from a PoolVector3Array.

Array Array ( PoolVector2Array from )

Construct an array from a PoolVector2Array.

Array Array ( PoolStringArray from )

Construct an array from a PoolStringArray.

Array Array ( PoolRealArray from )

Construct an array from a PoolRealArray.

Array Array ( PoolIntArray from )

Construct an array from a PoolIntArray.

Array Array ( PoolByteArray from )

Construct an array from a PoolByteArray.

void append ( var value )

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

var back ( )

Returns the last element of the array if the array is not empty (size>0).

int bsearch ( var value, bool before=True )

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.

int bsearch_custom ( var value, Object obj, String func, bool before=True )

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.

void clear ( )

Clear the array (resize to 0).

int count ( var value )

Return the amount of times an element is in the array.

Array duplicate ( )

Returns a copy of this Array.

bool empty ( )

Return true if the array is empty (size==0).

void erase ( var value )

Remove the first occurrence of a value from the array.

int find ( var what, int from=0 )

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

int find_last ( var value )

Searches the array in reverse order for a value and returns its index or -1 if not found.

var front ( )

Returns the first element of the array if the array is not empty (size>0).

bool has ( var value )

Return true if the array contains given value.

[ "inside", 7 ].has("inside") == true
[ "inside", 7 ].has("outside") == false
[ "inside", 7 ].has(7) == true
[ "inside", 7 ].has("7") == false

int hash ( )

Return a hashed integer value representing the array contents.

void insert ( int position, var value )

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()).

void invert ( )

Reverse the order of the elements in the array (so first element will now be the last) and return reference to the array.

var pop_back ( )

Remove the last element of the array.

var pop_front ( )

Remove the first element of the array.

void push_back ( var value )

Append an element at the end of the array.

void push_front ( var value )

Add an element at the beginning of the array.

void remove ( int position )

Remove an element from the array by index.

void resize ( int size )

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.

int rfind ( var what, int from=-1 )

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.

int size ( )

Return the amount of elements in the array.

void sort ( )

Sort the array using natural order and return reference to the array.

void sort_custom ( Object obj, String func )

Sort the array using a custom method and return reference to the array. 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. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior.

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")

© 2014–2018 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
http://docs.godotengine.org/en/3.0/classes/class_array.html