asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/PackedFloat64Array.xml

115 lines
3.2 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-25 18:10:58 +01:00
<class name="PackedFloat64Array" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<brief_description>
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-25 18:10:58 +01:00
A packed [Array] of 64-bit floating-point values.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</brief_description>
<description>
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-25 18:10:58 +01:00
An [Array] specifically designed to hold 64-bit floating-point values. Packs data tightly, so it saves memory for large array sizes.
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
[b]Note:[/b] This type is passed by value and not by reference.
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-25 18:10:58 +01:00
If you only need to pack 32-bit floats tightly, see [PackedFloat32Array] for a more memory-friendly alternative.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
<tutorials>
</tutorials>
<methods>
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-25 18:10:58 +01:00
<method name="PackedFloat64Array">
<return type="PackedFloat64Array">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-25 18:10:58 +01:00
Constructs a new [PackedFloat64Array]. Optionally, you can pass in a generic [Array] that will be converted.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="append">
doc: Sync classref with apparent Variant return type changes Part of those seem bogus, methods like Array.back()/front() should return a Variant and not void.
2020-02-22 15:16:32 +01:00
<return type="void">
</return>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<argument index="0" name="value" type="float">
</argument>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Appends an element at the end of the array (alias of [method push_back]).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="append_array">
doc: Sync classref with apparent Variant return type changes Part of those seem bogus, methods like Array.back()/front() should return a Variant and not void.
2020-02-22 15:16:32 +01:00
<return type="void">
</return>
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-25 18:10:58 +01:00
<argument index="0" name="array" type="PackedFloat64Array">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</argument>
<description>
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-25 18:10:58 +01:00
Appends a [PackedFloat64Array] at the end of this array.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Added empty() function to pool array types
2019-10-31 16:27:32 +01:00
<method name="empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="insert">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="invert">
doc: Sync classref with apparent Variant return type changes Part of those seem bogus, methods like Array.back()/front() should return a Variant and not void.
2020-02-22 15:16:32 +01:00
<return type="void">
</return>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Reverses the order of the elements in the array.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="push_back">
doc: Sync classref with apparent Variant return type changes Part of those seem bogus, methods like Array.back()/front() should return a Variant and not void.
2020-02-22 15:16:32 +01:00
<return type="void">
</return>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<argument index="0" name="value" type="float">
</argument>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Appends an element at the end of the array.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="remove">
doc: Sync classref with apparent Variant return type changes Part of those seem bogus, methods like Array.back()/front() should return a Variant and not void.
2020-02-22 15:16:32 +01:00
<return type="void">
</return>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<argument index="0" name="idx" type="int">
</argument>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Removes an element from the array by index.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="resize">
doc: Sync classref with apparent Variant return type changes Part of those seem bogus, methods like Array.back()/front() should return a Variant and not void.
2020-02-22 15:16:32 +01:00
<return type="void">
</return>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<argument index="0" name="idx" type="int">
</argument>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="set">
doc: Sync classref with apparent Variant return type changes Part of those seem bogus, methods like Array.back()/front() should return a Variant and not void.
2020-02-22 15:16:32 +01:00
<return type="void">
</return>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Changes the float at the given index.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="size">
<return type="int">
</return>
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 04:15:43 +02:00
Returns the size of the array.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<constants>
</constants>
</class>
Reference in a new issue Copy permalink