Complete documentation of packed arrays
This commit is contained in:
parent
17ca5b913c
commit
b099a8570c
9 changed files with 74 additions and 2 deletions
|
|
@ -184,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>
|
||||
|
|
@ -192,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>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue