summaryrefslogtreecommitdiff
path: root/doc/classes/PackedStringArray.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/PackedStringArray.xml')
-rw-r--r--doc/classes/PackedStringArray.xml43
1 files changed, 31 insertions, 12 deletions
diff --git a/doc/classes/PackedStringArray.xml b/doc/classes/PackedStringArray.xml
index 3cf43ecb28..a4653344f0 100644
--- a/doc/classes/PackedStringArray.xml
+++ b/doc/classes/PackedStringArray.xml
@@ -1,10 +1,16 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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>
@@ -55,6 +61,13 @@
[b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.
</description>
</method>
+ <method name="count" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="String" />
+ <description>
+ Returns the number of times an element is in the array.
+ </description>
+ </method>
<method name="duplicate">
<return type="PackedStringArray" />
<description>
@@ -68,6 +81,14 @@
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="find" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="String" />
+ <argument 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="has" qualifiers="const">
<return type="bool" />
<argument index="0" name="value" type="String" />
@@ -116,6 +137,14 @@
Reverses the order of the elements in the array.
</description>
</method>
+ <method name="rfind" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="value" type="String" />
+ <argument 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" />
@@ -155,11 +184,6 @@
<operators>
<operator name="operator !=">
<return type="bool" />
- <description>
- </description>
- </operator>
- <operator name="operator !=">
- <return type="bool" />
<argument index="0" name="right" type="PackedStringArray" />
<description>
</description>
@@ -172,11 +196,6 @@
</operator>
<operator name="operator ==">
<return type="bool" />
- <description>
- </description>
- </operator>
- <operator name="operator ==">
- <return type="bool" />
<argument index="0" name="right" type="PackedStringArray" />
<description>
</description>