Skip to content

Latest commit

 

History

History
118 lines (73 loc) · 6.52 KB

class_poolstringarray.rst

File metadata and controls

118 lines (73 loc) · 6.52 KB
Raw

PoolStringArray

Category: Built-In Types

Brief Description

String Array.

Member Functions

PoolStringArray<class_poolstringarray> PoolStringArray<class_PoolStringArray_PoolStringArray> ( Array<class_array> from )
void append<class_PoolStringArray_append> ( String<class_string> string )
void append_array<class_PoolStringArray_append_array> ( PoolStringArray<class_poolstringarray> array )
int<class_int> insert<class_PoolStringArray_insert> ( int<class_int> idx, String<class_string> string )
void invert<class_PoolStringArray_invert> ( )
String<class_string> join<class_PoolStringArray_join> ( String<class_string> delimiter )
void push_back<class_PoolStringArray_push_back> ( String<class_string> string )
void remove<class_PoolStringArray_remove> ( int<class_int> idx )
void resize<class_PoolStringArray_resize> ( int<class_int> idx )
void set<class_PoolStringArray_set> ( int<class_int> idx, String<class_string> string )
int<class_int> size<class_PoolStringArray_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<class_poolstringarray> PoolStringArray ( Array<class_array> from )

Create from a generic array.

  • void append ( String<class_string> string )

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

  • void append_array ( PoolStringArray<class_poolstringarray> array )

Append an StringArray at the end of this array.

  • int<class_int> insert ( int<class_int> idx, String<class_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<class_string> join ( String<class_string> delimiter )

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

  • void push_back ( String<class_string> string )

Append a string element at end of the array.

  • void remove ( int<class_int> idx )

Remove an element from the array by index.

  • void resize ( int<class_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<class_int> idx, String<class_string> string )

Change the String<class_string> at the given index.

  • int<class_int> size ( )

Return the size of the array.