diff options
Diffstat (limited to 'doc/classes/PackedStringArray.xml')
| -rw-r--r-- | doc/classes/PackedStringArray.xml | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/doc/classes/PackedStringArray.xml b/doc/classes/PackedStringArray.xml index 0e6afec2d9..2c3376d659 100644 --- a/doc/classes/PackedStringArray.xml +++ b/doc/classes/PackedStringArray.xml @@ -57,10 +57,16 @@ <param index="0" name="value" type="String" /> <param index="1" name="before" type="bool" default="true" /> <description> - 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 [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. + 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="clear"> + <return type="void" /> + <description> + Clears the array. This is equivalent to using [method resize] with a size of [code]0[/code]. + </description> + </method> <method name="count" qualifiers="const"> <return type="int" /> <param index="0" name="value" type="String" /> @@ -93,7 +99,7 @@ <return type="bool" /> <param index="0" name="value" type="String" /> <description> - Returns [code]true[/code] if the array contains [code]value[/code]. + Returns [code]true[/code] if the array contains [param value]. </description> </method> <method name="insert"> @@ -164,9 +170,9 @@ <param index="0" name="begin" type="int" /> <param index="1" name="end" type="int" default="2147483647" /> <description> - Returns the slice of the [PackedStringArray], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedStringArray]. - The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] 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 [code]begin[/code] or [code]end[/code] 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]). + 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="sort"> @@ -178,6 +184,7 @@ <method name="to_byte_array" qualifiers="const"> <return type="PackedByteArray" /> <description> + Returns a [PackedByteArray] with each string encoded as bytes. </description> </method> </methods> @@ -186,24 +193,28 @@ <return type="bool" /> <param index="0" name="right" type="PackedStringArray" /> <description> + Returns [code]true[/code] if contents of the arrays differ. </description> </operator> <operator name="operator +"> <return type="PackedStringArray" /> <param index="0" name="right" type="PackedStringArray" /> <description> + Returns a new [PackedStringArray] with contents of [param right] added at the end of this array. For better performance, consider using [method append_array] instead. </description> </operator> <operator name="operator =="> <return type="bool" /> <param index="0" name="right" type="PackedStringArray" /> <description> + Returns [code]true[/code] if contents of both arrays are the same, i.e. they have all equal [String]s at the corresponding indices. </description> </operator> <operator name="operator []"> <return type="String" /> <param index="0" name="index" type="int" /> <description> + Returns the [String] at index [param 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. </description> </operator> </operators> |