PackedStringArray

A packed Array of Strings.

Description

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

Tutorials

• OS Test Demo

Constructors

PackedStringArray	PackedStringArray ( )
PackedStringArray	PackedStringArray ( PackedStringArray from )
PackedStringArray	PackedStringArray ( Array from )

Methods

bool	append ( String value )
void	append_array ( PackedStringArray array )
int	bsearch ( String value, bool before=true )
PackedStringArray	duplicate ( )
void	fill ( String value )
bool	has ( String value ) const
int	insert ( int at_index, String value )
bool	is_empty ( ) const
bool	push_back ( String value )
void	remove ( int index )
int	resize ( int new_size )
void	reverse ( )
void	set ( int index, String value )
int	size ( ) const
void	sort ( )
PackedStringArray	subarray ( int from, int to ) const
PackedByteArray	to_byte_array ( ) const

Operators

bool	operator != ( )
bool	operator != ( PackedStringArray right )
PackedStringArray	operator + ( PackedStringArray right )
bool	operator == ( )
bool	operator == ( PackedStringArray right )
String	operator [] ( int index )

Constructor Descriptions

• PackedStringArray PackedStringArray ( )

Constructs an empty PackedStringArray.

---

• PackedStringArray PackedStringArray ( PackedStringArray from )

Constructs a PackedStringArray as a copy of the given PackedStringArray.

---

• PackedStringArray PackedStringArray ( Array from )

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

Method Descriptions

• bool append ( String value )

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.

---

• int bsearch ( String 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: Calling bsearch on an unsorted array results in unexpected behavior.

---

• PackedStringArray duplicate ( )

Creates a copy of the array, and returns it.

---

• void fill ( String value )

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.

---

• bool has ( String value ) const

Returns true if the array contains value.

---

• int insert ( int at_index, String value )

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

---

• bool is_empty ( ) const

Returns true if the array is empty.

---

• bool push_back ( String value )

Appends a string element at end of the array.

---

• void remove ( int index )

Removes an element from the array by index.

---

• int resize ( int new_size )

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

Reverses the order of the elements in the array.

---

• void set ( int index, String value )

Changes the String at the given index.

---

• int size ( ) const

Returns the size of the array.

---

• void sort ( )

Sorts the elements of the array in ascending order.

---

• PackedStringArray subarray ( int from, int to ) const

---

• PackedByteArray to_byte_array ( ) const

Operator Descriptions

• bool operator != ( )

---

• bool operator != ( PackedStringArray right )

---

• PackedStringArray operator + ( PackedStringArray right )

---

• bool operator == ( )

---

• bool operator == ( PackedStringArray right )

---

• String operator [] ( int index )