PoolStringArray

A pooled array of Strings.

Description

An array specifically designed to hold Strings. Optimized for memory usage, does not fragment the memory.

Note: This type is passed by value and not by reference. This means that when mutating a class property of type PoolStringArray or mutating a PoolStringArray within an Array or Dictionary, changes will be lost:

var array = [PoolStringArray()]
array[0].push_back("hello")
print(array)  # [[]] (empty PoolStringArray within an Array)

Instead, the entire PoolStringArray property must be reassigned with = for it to be changed:

var array = [PoolStringArray()]
var pool_array = array[0]
pool_array.push_back("hello")
array[0] = pool_array
print(array)  # [[hello]] (PoolStringArray with 1 element inside an Array)

Tutorials

Methods

PoolStringArray

PoolStringArray ( Array from )

void

append ( String string )

void

append_array ( PoolStringArray array )

int

count ( String value )

bool

empty ( )

void

fill ( String string )

int

find ( String value, int from=0 )

bool

has ( String value )

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 )

int

rfind ( String value, int from=-1 )

void

set ( int idx, String string )

int

size ( )

Method Descriptions

Constructs a new PoolStringArray. 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).


Appends a PoolStringArray at the end of this array.


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


Returns true if the array is empty.


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.


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


Returns true if the array contains the given value.

Note: This is equivalent to using the in operator.


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.


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


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


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. If the adjusted start index is out of bounds, this method searches from the end of the array.


Changes the String at the given index.


Returns the number of elements in the array.