mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-15 10:12:40 +08:00
Code Issues Packages Projects Releases Wiki Activity
6b11d8cc73
godot/doc/classes/PackedInt32Array.xml

212 lines
6.3 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-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-26 01:10:58 +08:00
<class name="PackedInt32Array" 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-13 04:42:36 +08:00
<brief_description>
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-26 01:10:58 +08:00
A packed [Array] of 32-bit integers.
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-13 04:42:36 +08:00
</brief_description>
<description>
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-26 01:10:58 +08:00
An [Array] specifically designed to hold 32-bit integer values. Packs data tightly, so it saves memory for large array sizes.
[b]Note:[/b] This type stores signed 32-bit integers, which means it can take values in the interval [code][-2^31, 2^31 - 1][/code], i.e. [code][-2147483648, 2147483647][/code]. Exceeding those bounds will wrap around. In comparison, [int] uses signed 64-bit integers which can hold much larger values. If you need to pack 64-bit integers tightly, see [PackedInt64Array].
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-13 04:42:36 +08:00
</description>
<tutorials>
</tutorials>
<methods>
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
<method name="PackedInt32Array" qualifiers="constructor">
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-10 00:46:03 +08:00
<return type="PackedInt32Array">
</return>
<description>
Constructs an empty [PackedInt32Array].
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
<method name="PackedInt32Array" qualifiers="constructor">
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-10 00:46:03 +08:00
<return type="PackedInt32Array">
</return>
<argument index="0" name="from" type="PackedInt32Array">
</argument>
<description>
Constructs a [PackedInt32Array] as a copy of the given [PackedInt32Array].
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
<method name="PackedInt32Array" qualifiers="constructor">
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-26 01:10:58 +08:00
<return type="PackedInt32Array">
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-13 04:42:36 +08:00
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-26 01:10:58 +08:00
Constructs a new [PackedInt32Array]. 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-13 04:42:36 +08:00
</description>
</method>
<method name="append">
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<return type="bool">
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 22:16:32 +08:00
</return>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<argument index="0" name="value" type="int">
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-13 04:42:36 +08:00
</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 07:04:47 +08: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-13 04:42:36 +08: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 22:16:32 +08:00
<return type="void">
</return>
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-26 01:10:58 +08:00
<argument index="0" name="array" type="PackedInt32Array">
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-13 04:42:36 +08:00
</argument>
<description>
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-26 01:10:58 +08:00
Appends a [PackedInt32Array] 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-13 04:42:36 +08:00
</description>
</method>
packed*arrays are pass by ref now. support duplicate and update documentation
2020-12-18 04:26:05 +08:00
<method name="duplicate">
<return type="PackedInt32Array">
</return>
<description>
Creates a copy of the array, and returns it.
</description>
</method>
Add fill method to Arrays and PackedArrays
2021-02-25 22:10:39 +08:00
<method name="fill">
<return type="void">
</return>
<argument index="0" name="value" type="int">
</argument>
<description>
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>
Add sort and has methods to PackedArrays
2020-02-21 12:19:00 +08:00
<method name="has">
<return type="bool">
</return>
<argument index="0" name="value" type="int">
</argument>
<description>
Returns [code]true[/code] if the array contains [code]value[/code].
</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-13 04:42:36 +08:00
<method name="insert">
<return type="int">
</return>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<argument index="0" name="at_index" type="int">
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-13 04:42:36 +08:00
</argument>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<argument index="1" name="value" type="int">
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-13 04:42:36 +08:00
</argument>
<description>
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 20:59:24 +08:00
Inserts a new integer 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-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="is_empty" qualifiers="const">
doc: Sync classref with current source
2021-01-04 21:33:44 +08:00
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 21:16:20 +08:00
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedInt32Array">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="PackedInt32Array">
</return>
<argument index="0" name="right" type="PackedInt32Array">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="PackedInt32Array">
</argument>
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
<return type="int">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</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-13 04:42:36 +08:00
<method name="push_back">
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<return type="bool">
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 22:16:32 +08:00
</return>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<argument index="0" name="value" type="int">
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-13 04:42:36 +08:00
</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 07:04:47 +08:00
Appends a value to 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-13 04:42:36 +08: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 22:16:32 +08:00
<return type="void">
</return>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<argument index="0" name="index" type="int">
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-13 04:42:36 +08:00
</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 07:04:47 +08: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-13 04:42:36 +08:00
</description>
</method>
<method name="resize">
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<return type="int">
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 22:16:32 +08:00
</return>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<argument index="0" name="new_size" type="int">
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-13 04:42:36 +08:00
</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 07:04:47 +08: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-13 04:42:36 +08:00
</description>
</method>
Fix misformatted documentation from #47435, #42827, #46991
2021-04-05 04:25:40 +08:00
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</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-13 04:42:36 +08:00
<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 22:16:32 +08:00
<return type="void">
</return>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<argument index="0" name="index" type="int">
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-13 04:42:36 +08:00
</argument>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<argument index="1" name="value" type="int">
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-13 04:42:36 +08:00
</argument>
<description>
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 20:59:24 +08:00
Changes the integer 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-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="size" qualifiers="const">
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-13 04:42:36 +08:00
<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 10:15:43 +08:00
Returns the array 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-13 04:42:36 +08:00
</description>
</method>
Add sort and has methods to PackedArrays
2020-02-21 12:19:00 +08:00
<method name="sort">
<return type="void">
</return>
<description>
Sorts the elements of the array in ascending order.
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="subarray" qualifiers="const">
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<return type="PackedInt32Array">
</return>
<argument index="0" name="from" type="int">
</argument>
<argument index="1" name="to" type="int">
</argument>
<description>
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 21:44:42 +08:00
<method name="to_byte_array" qualifiers="const">
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
<return type="PackedByteArray">
</return>
<description>
New to_***_array method to decode PackedByteArray to Packed***Array Documentation for new PackedByteArray::to_***_array methods Documentation for to_byte_array method for PackedInt32/Int64/Float32/Float64Array
2021-07-17 06:36:45 +08:00
Returns a copy of the data converted to a [PackedByteArray], where each element have been encoded as 4 bytes.
The size of the new array will be [code]int32_array.size() * 4[/code].
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 22:38:26 +08:00
</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-13 04:42:36 +08:00
</methods>
<constants>
</constants>
</class>
Reference in New Issue Copy Permalink