diff options
Diffstat (limited to 'doc/classes/PackedVector3Array.xml')
| -rw-r--r-- | doc/classes/PackedVector3Array.xml | 117 |
1 files changed, 69 insertions, 48 deletions
diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml index 1a35f71619..df69e3cd4a 100644 --- a/doc/classes/PackedVector3Array.xml +++ b/doc/classes/PackedVector3Array.xml @@ -8,27 +8,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedVector3Array" qualifiers="constructor"> + <constructors> + <constructor name="PackedVector3Array"> <return type="PackedVector3Array" /> <description> Constructs an empty [PackedVector3Array]. </description> - </method> - <method name="PackedVector3Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedVector3Array"> <return type="PackedVector3Array" /> <argument index="0" name="from" type="PackedVector3Array" /> <description> Constructs a [PackedVector3Array] as a copy of the given [PackedVector3Array]. </description> - </method> - <method name="PackedVector3Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedVector3Array"> <return type="PackedVector3Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedVector3Array]. 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="Vector3" /> @@ -43,6 +45,15 @@ Appends a [PackedVector3Array] at the end of this array. </description> </method> + <method name="bsearch"> + <return type="int" /> + <argument index="0" name="value" type="Vector3" /> + <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="PackedVector3Array" /> <description> @@ -56,7 +67,7 @@ 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="has"> + <method name="has" qualifiers="const"> <return type="bool" /> <argument index="0" name="value" type="Vector3" /> <description> @@ -77,36 +88,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedVector3Array" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="PackedVector3Array" /> - <argument index="0" name="right" type="Transform3D" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedVector3Array" /> - <argument index="0" name="right" type="PackedVector3Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedVector3Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="Vector3" /> @@ -114,7 +95,7 @@ Inserts a [Vector3] at the end. </description> </method> - <method name="remove"> + <method name="remove_at"> <return type="void" /> <argument index="0" name="index" type="int" /> <description> @@ -148,17 +129,17 @@ Returns the size of the array. </description> </method> - <method name="sort"> - <return type="void" /> + <method name="slice" qualifiers="const"> + <return type="PackedVector3Array" /> + <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="PackedVector3Array" /> - <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"> @@ -167,6 +148,46 @@ </description> </method> </methods> - <constants> - </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedVector3Array" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="PackedVector3Array" /> + <argument index="0" name="right" type="Transform3D" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedVector3Array" /> + <argument index="0" name="right" type="PackedVector3Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedVector3Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="Vector3" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> |