diff options
Diffstat (limited to 'doc/classes/PackedStringArray.xml')
| -rw-r--r-- | doc/classes/PackedStringArray.xml | 169 |
1 files changed, 109 insertions, 60 deletions
diff --git a/doc/classes/PackedStringArray.xml b/doc/classes/PackedStringArray.xml index 04113d4a2e..b58a3b2553 100644 --- a/doc/classes/PackedStringArray.xml +++ b/doc/classes/PackedStringArray.xml @@ -1,124 +1,138 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PackedStringArray" version="4.0"> +<class name="PackedStringArray" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> - A packed [Array] of [String]s. + A packed array of [String]s. </brief_description> <description> - An [Array] specifically designed to hold [String]s. Packs data tightly, so it saves memory for large array sizes. + An array specifically designed to hold [String]s. Packs data tightly, so it saves memory for large array sizes. + If you want to join the strings in the array, use [method String.join]. + [codeblock] + var string_array = PackedStringArray(["hello", "world"]) + var string = " ".join(string_array) + print(string) # "hello world" + [/codeblock] </description> <tutorials> <link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link> </tutorials> - <methods> - <method name="PackedStringArray" qualifiers="constructor"> + <constructors> + <constructor name="PackedStringArray"> <return type="PackedStringArray" /> <description> Constructs an empty [PackedStringArray]. </description> - </method> - <method name="PackedStringArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedStringArray"> <return type="PackedStringArray" /> - <argument index="0" name="from" type="PackedStringArray" /> + <param index="0" name="from" type="PackedStringArray" /> <description> Constructs a [PackedStringArray] as a copy of the given [PackedStringArray]. </description> - </method> - <method name="PackedStringArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedStringArray"> <return type="PackedStringArray" /> - <argument index="0" name="from" type="Array" /> + <param index="0" name="from" type="Array" /> <description> Constructs a new [PackedStringArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> - <argument index="0" name="value" type="String" /> + <param index="0" name="value" type="String" /> <description> Appends an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <return type="void" /> - <argument index="0" name="array" type="PackedStringArray" /> + <param index="0" name="array" type="PackedStringArray" /> <description> Appends a [PackedStringArray] at the end of this array. </description> </method> - <method name="duplicate"> - <return type="PackedStringArray" /> + <method name="bsearch"> + <return type="int" /> + <param index="0" name="value" type="String" /> + <param index="1" name="before" type="bool" default="true" /> <description> - Creates a copy of the array, and returns it. + 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 [param before] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. + [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. </description> </method> - <method name="fill"> + <method name="clear"> <return type="void" /> - <argument index="0" name="value" type="String" /> <description> - Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. + Clears the array. This is equivalent to using [method resize] with a size of [code]0[/code]. </description> </method> - <method name="has"> - <return type="bool" /> - <argument index="0" name="value" type="String" /> + <method name="count" qualifiers="const"> + <return type="int" /> + <param index="0" name="value" type="String" /> <description> - Returns [code]true[/code] if the array contains [code]value[/code]. + Returns the number of times an element is in the array. </description> </method> - <method name="insert"> - <return type="int" /> - <argument index="0" name="at_index" type="int" /> - <argument index="1" name="value" type="String" /> + <method name="duplicate"> + <return type="PackedStringArray" /> <description> - Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + Creates a copy of the array, and returns it. </description> </method> - <method name="is_empty" qualifiers="const"> - <return type="bool" /> + <method name="fill"> + <return type="void" /> + <param index="0" name="value" type="String" /> <description> - Returns [code]true[/code] if the array is empty. + Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedStringArray" /> + <method name="find" qualifiers="const"> + <return type="int" /> + <param index="0" name="value" type="String" /> + <param index="1" name="from" type="int" default="0" /> <description> + Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedStringArray" /> - <argument index="0" name="right" type="PackedStringArray" /> + <method name="has" qualifiers="const"> + <return type="bool" /> + <param index="0" name="value" type="String" /> <description> + Returns [code]true[/code] if the array contains [param value]. </description> </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedStringArray" /> + <method name="insert"> + <return type="int" /> + <param index="0" name="at_index" type="int" /> + <param index="1" name="value" type="String" /> <description> + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). </description> </method> - <method name="operator []" qualifiers="operator"> - <return type="String" /> - <argument index="0" name="index" type="int" /> + <method name="is_empty" qualifiers="const"> + <return type="bool" /> <description> + Returns [code]true[/code] if the array is empty. </description> </method> <method name="push_back"> <return type="bool" /> - <argument index="0" name="value" type="String" /> + <param index="0" name="value" type="String" /> <description> Appends a string element at end of the array. </description> </method> - <method name="remove"> + <method name="remove_at"> <return type="void" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Removes an element from the array by index. </description> </method> <method name="resize"> <return type="int" /> - <argument index="0" name="new_size" type="int" /> + <param index="0" name="new_size" type="int" /> <description> 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. </description> @@ -129,10 +143,18 @@ Reverses the order of the elements in the array. </description> </method> + <method name="rfind" qualifiers="const"> + <return type="int" /> + <param index="0" name="value" type="String" /> + <param index="1" name="from" type="int" default="-1" /> + <description> + 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. + </description> + </method> <method name="set"> <return type="void" /> - <argument index="0" name="index" type="int" /> - <argument index="1" name="value" type="String" /> + <param index="0" name="index" type="int" /> + <param index="1" name="value" type="String" /> <description> Changes the [String] at the given index. </description> @@ -140,20 +162,23 @@ <method name="size" qualifiers="const"> <return type="int" /> <description> - Returns the size of the array. + Returns the number of elements in the array. </description> </method> - <method name="sort"> - <return type="void" /> + <method name="slice" qualifiers="const"> + <return type="PackedStringArray" /> + <param index="0" name="begin" type="int" /> + <param index="1" name="end" type="int" default="2147483647" /> <description> - Sorts the elements of the array in ascending order. + Returns the slice of the [PackedStringArray], from [param begin] (inclusive) to [param end] (exclusive), as a new [PackedStringArray]. + The absolute value of [param begin] and [param end] will be clamped to the array size, so the default value for [param end] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). + If either [param begin] or [param end] are negative, they will be relative to the end of the array (i.e. [code]arr.slice(0, -2)[/code] is a shorthand for [code]arr.slice(0, arr.size() - 2)[/code]). </description> </method> - <method name="subarray" qualifiers="const"> - <return type="PackedStringArray" /> - <argument index="0" name="from" type="int" /> - <argument index="1" name="to" type="int" /> + <method name="sort"> + <return type="void" /> <description> + Sorts the elements of the array in ascending order. </description> </method> <method name="to_byte_array" qualifiers="const"> @@ -162,6 +187,30 @@ </description> </method> </methods> - <constants> - </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <param index="0" name="right" type="PackedStringArray" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedStringArray" /> + <param index="0" name="right" type="PackedStringArray" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <param index="0" name="right" type="PackedStringArray" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="String" /> + <param index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> |