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.

If you want to join the strings in the array, use String.join.

var string_array = PackedStringArray(["hello", "world"])
var string = " ".join(string_array)
print(string) # "hello world"

Note

There are notable differences when using this API with C#. See C# API differences to GDScript for more information.

Tutorials

• OS Test Demo

Constructors

Methods

Operators

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.

void clear ( )

Clears the array. This is equivalent to using resize with a size of 0.

int count ( String value ) const

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

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.

int find ( String value, int from=0 ) const

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

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

int rfind ( String value, int from=-1 ) const

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.

void set ( int index, String value )

Changes the String at the given index.

int size ( ) const

Returns the number of elements in the array.

PackedStringArray slice ( int begin, int end=2147483647 ) const

Returns the slice of the PackedStringArray, from begin (inclusive) to end (exclusive), as a new PackedStringArray.

The absolute value of begin and end will be clamped to the array size, so the default value for end makes it slice to the size of the array by default (i.e. arr.slice(1) is a shorthand for arr.slice(1, arr.size())).

If either begin or end are negative, they will be relative to the end of the array (i.e. arr.slice(0, -2) is a shorthand for arr.slice(0, arr.size() - 2)).

void sort ( )

Sorts the elements of the array in ascending order.

PackedByteArray to_byte_array ( ) const

Returns a PackedByteArray with each string encoded as bytes.

Operator Descriptions

bool operator != ( PackedStringArray right )

Returns true if contents of the arrays differ.

PackedStringArray operator + ( PackedStringArray right )

Returns a new PackedStringArray with contents of right added at the end of this array. For better performance, consider using append_array instead.

bool operator == ( PackedStringArray right )

Returns true if contents of both arrays are the same, i.e. they have all equal Strings at the corresponding indices.

String operator [] ( int index )

Returns the String at index index. Negative indices can be used to access the elements starting from the end. Using index out of array’s bounds will result in an error.

Previous Next

© Copyright 2014-present Juan Linietsky, Ariel Manzur and the Godot community (CC BY 3.0). Revision 53e837c6.

Built with Sphinx using a theme provided by Read the Docs.