Description

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

If you want to join the strings in the array, useString.join().

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

Differences between packed arrays, typed arrays, and untyped arrays: Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g.PackedStringArray versusArray[String]). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such asArray.map(). Typed arrays are in turn faster to iterate on and modify than untyped arrays.

Note: Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, useduplicate(). This isnot the case for built-in properties and methods. The returned packed array of these are a copies, and changing it willnot affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again.

Tutorials

• Operating System Testing Demo

Constructors

Methods

Operators

Constructor Descriptions

PackedStringArrayPackedStringArray()🔗

Constructs an emptyPackedStringArray.

PackedStringArrayPackedStringArray(from:PackedStringArray)

Constructs aPackedStringArray as a copy of the givenPackedStringArray.

PackedStringArrayPackedStringArray(from:Array)

Constructs a newPackedStringArray. Optionally, you can pass in a genericArray that will be converted.

Method Descriptions

boolappend(value:String)🔗

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

voidappend_array(array:PackedStringArray)🔗

Appends aPackedStringArray at the end of this array.

intbsearch(value:String, before:bool = 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, abefore specifier can be passed. Iffalse, the returned index comes after all existing entries of the value in the array.

Note: Callingbsearch() on an unsorted array results in unexpected behavior.

voidclear()🔗

Clears the array. This is equivalent to usingresize() with a size of0.

intcount(value:String)const🔗

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

PackedStringArrayduplicate()🔗

Creates a copy of the array, and returns it.

voidfill(value:String)🔗

Assigns the given value to all elements in the array. This can typically be used together withresize() to create an array with a given size and initialized elements.

intfind(value:String, from:int = 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.

Stringget(index:int)const🔗

Returns theString at the givenindex in the array. This is the same as using the[] operator (array[index]).

boolhas(value:String)const🔗

Returnstrue if the array containsvalue.

intinsert(at_index:int, value: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()).

boolis_empty()const🔗

Returnstrue if the array is empty.

boolpush_back(value:String)🔗

Appends a string element at end of the array.

voidremove_at(index:int)🔗

Removes an element from the array by index.

intresize(new_size:int)🔗

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. Callingresize() once and assigning the new values is faster than adding new elements one by one.

voidreverse()🔗

Reverses the order of the elements in the array.

intrfind(value:String, from:int = -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.

voidset(index:int, value:String)🔗

Changes theString at the given index.

intsize()const🔗

Returns the number of elements in the array.

PackedStringArrayslice(begin:int, end:int = 2147483647)const🔗

Returns the slice of thePackedStringArray, frombegin (inclusive) toend (exclusive), as a newPackedStringArray.

The absolute value ofbegin andend will be clamped to the array size, so the default value forend makes it slice to the size of the array by default (i.e.arr.slice(1) is a shorthand forarr.slice(1,arr.size())).

If eitherbegin orend are negative, they will be relative to the end of the array (i.e.arr.slice(0,-2) is a shorthand forarr.slice(0,arr.size()-2)).

voidsort()🔗

Sorts the elements of the array in ascending order.

PackedByteArrayto_byte_array()const🔗

Returns aPackedByteArray with each string encoded as UTF-8. Strings arenull terminated.

Operator Descriptions

booloperator !=(right:PackedStringArray)🔗

Returnstrue if contents of the arrays differ.

PackedStringArrayoperator +(right:PackedStringArray)🔗

Returns a newPackedStringArray with contents ofright added at the end of this array. For better performance, consider usingappend_array() instead.

booloperator ==(right:PackedStringArray)🔗

Returnstrue if contents of both arrays are the same, i.e. they have all equalStrings at the corresponding indices.

Stringoperator [](index:int)🔗

Returns theString at indexindex. 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.