PackedStringArray¶

Description¶

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

Note: This type is passed by value and not by reference.

Methods¶

PackedStringArray	PackedStringArray ( Array from )
void	append ( String string )
void	append_array ( PackedStringArray array )
bool	empty ( )
int	insert ( int idx, String string )
void	invert ( )
void	push_back ( String string )
void	remove ( int idx )
void	resize ( int idx )
void	set ( int idx, String string )
int	size ( )

Method Descriptions¶

PackedStringArray PackedStringArray ( Array from )

Constructs a new PackedStringArray. Optionally, you can pass in a generic Array that will be converted.

void append ( String string )

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

void append_array ( PackedStringArray array )

Appends a PackedStringArray at the end of this array.

bool empty ( )

Returns true if the array is empty.

int insert ( int idx, String string )

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

void invert ( )

Reverses the order of the elements in the array.

void push_back ( String string )

Appends a string element at end of the array.

void remove ( int idx )

Removes an element from the array by index.

void resize ( int idx )

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.

void set ( int idx, String string )

Changes the String at the given index.

int size ( )

Returns the size of the array.