W3cubDocs

/Godot 3.0

PoolStringArray

Category: Built-In Types

Brief Description

String Array.

Member Functions

PoolStringArray PoolStringArray ( Array from )
void append ( String string )
void append_array ( PoolStringArray array )
int insert ( int idx, String string )
void invert ( )
String join ( String delimiter )
void push_back ( String string )
void remove ( int idx )
void resize ( int idx )
void set ( int idx, String string )
int size ( )

Description

String Array. Array of strings. Can only contain strings. Optimized for memory usage, can’t fragment the memory. Note that this type is passed by value and not by reference.

Member Function Description

PoolStringArray PoolStringArray ( Array from )

Create from a generic array.

void append ( String string )

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

void append_array ( PoolStringArray array )

Append an StringArray at the end of this array.

int insert ( int idx, String string )

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

String join ( String delimiter )

Returns a String with each element of the array joined with the delimiter.

void push_back ( String string )

Append a string element at end of the array.

void remove ( int idx )

Remove an element from the array by index.

void resize ( int idx )

Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size.

void set ( int idx, String string )

Change the String at the given index.

int size ( )

Return the size of the array.

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