summaryrefslogtreecommitdiff
path: root/doc/classes/PackedFloat32Array.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/PackedFloat32Array.xml')
-rw-r--r--doc/classes/PackedFloat32Array.xml111
1 files changed, 62 insertions, 49 deletions
diff --git a/doc/classes/PackedFloat32Array.xml b/doc/classes/PackedFloat32Array.xml
index 51e14ea3d4..151014192f 100644
--- a/doc/classes/PackedFloat32Array.xml
+++ b/doc/classes/PackedFloat32Array.xml
@@ -9,27 +9,29 @@
</description>
<tutorials>
</tutorials>
- <methods>
- <method name="PackedFloat32Array" qualifiers="constructor">
+ <constructors>
+ <constructor name="PackedFloat32Array">
<return type="PackedFloat32Array" />
<description>
Constructs an empty [PackedFloat32Array].
</description>
- </method>
- <method name="PackedFloat32Array" qualifiers="constructor">
+ </constructor>
+ <constructor name="PackedFloat32Array">
<return type="PackedFloat32Array" />
<argument index="0" name="from" type="PackedFloat32Array" />
<description>
Constructs a [PackedFloat32Array] as a copy of the given [PackedFloat32Array].
</description>
- </method>
- <method name="PackedFloat32Array" qualifiers="constructor">
+ </constructor>
+ <constructor name="PackedFloat32Array">
<return type="PackedFloat32Array" />
<argument index="0" name="from" type="Array" />
<description>
Constructs a new [PackedFloat32Array]. 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="float" />
@@ -44,6 +46,15 @@
Appends a [PackedFloat32Array] at the end of this array.
</description>
</method>
+ <method name="bsearch">
+ <return type="int" />
+ <argument index="0" name="value" type="float" />
+ <argument 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.
+ [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.
+ </description>
+ </method>
<method name="duplicate">
<return type="PackedFloat32Array" />
<description>
@@ -78,40 +89,6 @@
Returns [code]true[/code] if the array is empty.
</description>
</method>
- <method name="operator !=" qualifiers="operator">
- <return type="bool" />
- <description>
- </description>
- </method>
- <method name="operator !=" qualifiers="operator">
- <return type="bool" />
- <argument index="0" name="right" type="PackedFloat32Array" />
- <description>
- </description>
- </method>
- <method name="operator +" qualifiers="operator">
- <return type="PackedFloat32Array" />
- <argument index="0" name="right" type="PackedFloat32Array" />
- <description>
- </description>
- </method>
- <method name="operator ==" qualifiers="operator">
- <return type="bool" />
- <description>
- </description>
- </method>
- <method name="operator ==" qualifiers="operator">
- <return type="bool" />
- <argument index="0" name="right" type="PackedFloat32Array" />
- <description>
- </description>
- </method>
- <method name="operator []" qualifiers="operator">
- <return type="float" />
- <argument index="0" name="index" type="int" />
- <description>
- </description>
- </method>
<method name="push_back">
<return type="bool" />
<argument index="0" name="value" type="float" />
@@ -119,7 +96,7 @@
Appends an element at the end of the array.
</description>
</method>
- <method name="remove">
+ <method name="remove_at">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
@@ -153,17 +130,17 @@
Returns the size of the array.
</description>
</method>
- <method name="sort">
- <return type="void" />
+ <method name="slice" qualifiers="const">
+ <return type="PackedFloat32Array" />
+ <argument index="0" name="begin" type="int" />
+ <argument index="1" name="end" type="int" />
<description>
- Sorts the elements of the array in ascending order.
</description>
</method>
- <method name="subarray" qualifiers="const">
- <return type="PackedFloat32Array" />
- <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">
@@ -174,4 +151,40 @@
</description>
</method>
</methods>
+ <operators>
+ <operator name="operator !=">
+ <return type="bool" />
+ <description>
+ </description>
+ </operator>
+ <operator name="operator !=">
+ <return type="bool" />
+ <argument index="0" name="right" type="PackedFloat32Array" />
+ <description>
+ </description>
+ </operator>
+ <operator name="operator +">
+ <return type="PackedFloat32Array" />
+ <argument index="0" name="right" type="PackedFloat32Array" />
+ <description>
+ </description>
+ </operator>
+ <operator name="operator ==">
+ <return type="bool" />
+ <description>
+ </description>
+ </operator>
+ <operator name="operator ==">
+ <return type="bool" />
+ <argument index="0" name="right" type="PackedFloat32Array" />
+ <description>
+ </description>
+ </operator>
+ <operator name="operator []">
+ <return type="float" />
+ <argument index="0" name="index" type="int" />
+ <description>
+ </description>
+ </operator>
+ </operators>
</class>