maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #36542 from akien-mga/doc-64-arrays

Browse source 
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
This commit is contained in:
Rémi Verschelde 2020-02-25 22:19:55 +01:00 committed by GitHub
parent 2ead439370 a7e1df4b1d
commit 2d980f6f13
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
33 changed files with 360 additions and 89 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
doc/classes/@GlobalScope.xml
View file

@ -1543,25 +1543,31 @@
<constant name="TYPE_RAW_ARRAY" value="26" enum="Variant.Type">
Variable is of type [PackedByteArray].
</constant>
<constant name="TYPE_INT_ARRAY" value="27" enum="Variant.Type">
Variable is of type [PackedIntArray].
<constant name="TYPE_INT32_ARRAY" value="27" enum="Variant.Type">
Variable is of type [PackedInt32Array].
</constant>
<constant name="TYPE_REAL_ARRAY" value="28" enum="Variant.Type">
Variable is of type [PackedRealArray].
<constant name="TYPE_INT64_ARRAY" value="28" enum="Variant.Type">
Variable is of type [PackedInt64Array].
</constant>
<constant name="TYPE_STRING_ARRAY" value="29" enum="Variant.Type">
<constant name="TYPE_FLOAT32_ARRAY" value="29" enum="Variant.Type">
Variable is of type [PackedFloat32Array].
</constant>
<constant name="TYPE_FLOAT64_ARRAY" value="30" enum="Variant.Type">
Variable is of type [PackedFloat64Array].
</constant>
<constant name="TYPE_STRING_ARRAY" value="31" enum="Variant.Type">
Variable is of type [PackedStringArray].
</constant>
<constant name="TYPE_VECTOR2_ARRAY" value="30" enum="Variant.Type">
<constant name="TYPE_VECTOR2_ARRAY" value="32" enum="Variant.Type">
Variable is of type [PackedVector2Array].
</constant>
<constant name="TYPE_VECTOR3_ARRAY" value="31" enum="Variant.Type">
<constant name="TYPE_VECTOR3_ARRAY" value="33" enum="Variant.Type">
Variable is of type [PackedVector3Array].
</constant>
<constant name="TYPE_COLOR_ARRAY" value="32" enum="Variant.Type">
<constant name="TYPE_COLOR_ARRAY" value="34" enum="Variant.Type">
Variable is of type [PackedColorArray].
</constant>
<constant name="TYPE_MAX" value="33" enum="Variant.Type">
<constant name="TYPE_MAX" value="35" enum="Variant.Type">
Represents the size of the [enum Variant.Type] enum.
</constant>
<constant name="OP_EQUAL" value="0" enum="Variant.Operator">

4
doc/classes/AStar.xml
View file

@ -152,7 +152,7 @@
</description>
</method>
<method name="get_id_path">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="from_id" type="int">
</argument>
@ -185,7 +185,7 @@
</description>
</method>
<method name="get_point_connections">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="id" type="int">
</argument>

4
doc/classes/AStar2D.xml
View file

@ -111,7 +111,7 @@
</description>
</method>
<method name="get_id_path">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="from_id" type="int">
</argument>
@ -144,7 +144,7 @@
</description>
</method>
<method name="get_point_connections">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="id" type="int">
</argument>

4
doc/classes/Animation.xml
View file

@ -274,7 +274,7 @@
</description>
</method>
<method name="method_track_get_key_indices" qualifiers="const">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="track_idx" type="int">
</argument>
@ -627,7 +627,7 @@
</description>
</method>
<method name="value_track_get_key_indices" qualifiers="const">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="track_idx" type="int">
</argument>

26
doc/classes/Array.xml
View file

@ -58,19 +58,37 @@
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedRealArray">
<argument index="0" name="from" type="PackedFloat64Array">
</argument>
<description>
Constructs an array from a [PackedRealArray].
Constructs an array from a [PackedFloat64Array].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedIntArray">
<argument index="0" name="from" type="PackedFloat32Array">
</argument>
<description>
Constructs an array from a [PackedIntArray].
Constructs an array from a [PackedFloat32Array].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedInt64Array">
</argument>
<description>
Constructs an array from a [PackedInt64Array].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PackedInt32Array">
</argument>
<description>
Constructs an array from a [PackedInt32Array].
</description>
</method>
<method name="Array">

8
doc/classes/ArrayMesh.xml
View file

@ -208,7 +208,7 @@
[PackedVector3Array] of vertex normals.
</constant>
<constant name="ARRAY_TANGENT" value="2" enum="ArrayType">
[PackedRealArray] of vertex tangents. Each element in groups of 4 floats, first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
[PackedFloat32Array] of vertex tangents. Each element in groups of 4 floats, first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
</constant>
<constant name="ARRAY_COLOR" value="3" enum="ArrayType">
[PackedColorArray] of vertex colors.
@ -220,13 +220,13 @@
[PackedVector2Array] for second UV coordinates.
</constant>
<constant name="ARRAY_BONES" value="6" enum="ArrayType">
[PackedRealArray] or [PackedIntArray] of bone indices. Each element in groups of 4 floats.
[PackedFloat32Array] or [PackedInt32Array] of bone indices. Each element in groups of 4 floats.
</constant>
<constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType">
[PackedRealArray] of bone weights. Each element in groups of 4 floats.
[PackedFloat32Array] of bone weights. Each element in groups of 4 floats.
</constant>
<constant name="ARRAY_INDEX" value="8" enum="ArrayType">
[PackedIntArray] of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the *i*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices.
[PackedInt32Array] of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the *i*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices.
For triangles, the index array is interpreted as triples, referring to the vertices of each triangle. For lines, the index array is in pairs indicating the start and end of each line.
</constant>
<constant name="ARRAY_MAX" value="9" enum="ArrayType">

4
doc/classes/Curve3D.xml
View file

@ -48,10 +48,10 @@
</description>
</method>
<method name="get_baked_tilts" qualifiers="const">
<return type="PackedRealArray">
<return type="PackedFloat32Array">
</return>
<description>
Returns the cache of tilts as a [PackedRealArray].
Returns the cache of tilts as a [PackedFloat32Array].
</description>
</method>
<method name="get_baked_up_vectors" qualifiers="const">

4
doc/classes/GIProbeData.xml
View file

@ -22,7 +22,7 @@
</argument>
<argument index="5" name="distance_field" type="PackedByteArray">
</argument>
<argument index="6" name="level_counts" type="PackedIntArray">
<argument index="6" name="level_counts" type="PackedInt32Array">
</argument>
<description>
</description>
@ -40,7 +40,7 @@
</description>
</method>
<method name="get_level_counts" qualifiers="const">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<description>
</description>

8
doc/classes/Geometry.xml
View file

@ -445,21 +445,21 @@
</description>
</method>
<method name="triangulate_delaunay_2d">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="points" type="PackedVector2Array">
</argument>
<description>
Triangulates the area specified by discrete set of [code]points[/code] such that no point is inside the circumcircle of any resulting triangle. Returns a [PackedIntArray] where each triangle consists of three consecutive point indices into [code]points[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PackedIntArray] is returned.
Triangulates the area specified by discrete set of [code]points[/code] such that no point is inside the circumcircle of any resulting triangle. Returns a [PackedInt32Array] where each triangle consists of three consecutive point indices into [code]points[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PackedInt32Array] is returned.
</description>
</method>
<method name="triangulate_polygon">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="polygon" type="PackedVector2Array">
</argument>
<description>
Triangulates the polygon specified by the points in [code]polygon[/code]. Returns a [PackedIntArray] where each triangle consists of three consecutive point indices into [code]polygon[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PackedIntArray] is returned.
Triangulates the polygon specified by the points in [code]polygon[/code]. Returns a [PackedInt32Array] where each triangle consists of three consecutive point indices into [code]polygon[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PackedInt32Array] is returned.
</description>
</method>
</methods>

4
doc/classes/Gradient.xml
View file

@ -90,8 +90,8 @@
<member name="colors" type="PackedColorArray" setter="set_colors" getter="get_colors" default="PackedColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )">
Gradient's colors returned as a [PackedColorArray].
</member>
<member name="offsets" type="PackedRealArray" setter="set_offsets" getter="get_offsets" default="PackedRealArray( 0, 1 )">
Gradient's offsets returned as a [PackedRealArray].
<member name="offsets" type="PackedFloat32Array" setter="set_offsets" getter="get_offsets" default="PackedFloat32Array( 0, 1 )">
Gradient's offsets returned as a [PackedFloat32Array].
</member>
</members>
<constants>

2
doc/classes/HeightMapShape.xml
View file

@ -11,7 +11,7 @@
<methods>
</methods>
<members>
<member name="map_data" type="PackedRealArray" setter="set_map_data" getter="get_map_data" default="PackedRealArray( 0, 0, 0, 0 )">
<member name="map_data" type="PackedFloat32Array" setter="set_map_data" getter="get_map_data" default="PackedFloat32Array( 0, 0, 0, 0 )">
Height map data, pool array must be of [member map_width] * [member map_depth] size.
</member>
<member name="map_depth" type="int" setter="set_map_depth" getter="get_map_depth" default="2">

2
doc/classes/ItemList.xml
View file

@ -142,7 +142,7 @@
</description>
</method>
<method name="get_selected_items">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<description>
Returns an array with the indexes of the selected items.

14
doc/classes/MeshDataTool.xml
View file

@ -57,7 +57,7 @@
</description>
</method>
<method name="get_edge_faces" qualifiers="const">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -160,7 +160,7 @@
</description>
</method>
<method name="get_vertex_bones" qualifiers="const">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -185,7 +185,7 @@
</description>
</method>
<method name="get_vertex_edges" qualifiers="const">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -194,7 +194,7 @@
</description>
</method>
<method name="get_vertex_faces" qualifiers="const">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -248,7 +248,7 @@
</description>
</method>
<method name="get_vertex_weights" qualifiers="const">
<return type="PackedRealArray">
<return type="PackedFloat32Array">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -303,7 +303,7 @@
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="bones" type="PackedIntArray">
<argument index="1" name="bones" type="PackedInt32Array">
</argument>
<description>
Sets the bones of the given vertex.
@ -380,7 +380,7 @@
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="weights" type="PackedRealArray">
<argument index="1" name="weights" type="PackedFloat32Array">
</argument>
<description>
Sets the bone weights of the given vertex.

2
doc/classes/MeshLibrary.xml
View file

@ -36,7 +36,7 @@
</description>
</method>
<method name="get_item_list" qualifiers="const">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<description>
Returns the list of item IDs in use.

2
doc/classes/MultiMesh.xml
View file

@ -105,7 +105,7 @@
</method>
</methods>
<members>
<member name="buffer" type="PackedRealArray" setter="set_buffer" getter="get_buffer" default="PackedRealArray( )">
<member name="buffer" type="PackedFloat32Array" setter="set_buffer" getter="get_buffer" default="PackedFloat32Array( )">
</member>
<member name="color_array" type="PackedColorArray" setter="_set_color_array" getter="_get_color_array">
</member>

2
doc/classes/MultiplayerAPI.xml
View file

@ -19,7 +19,7 @@
</description>
</method>
<method name="get_network_connected_peers" qualifiers="const">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<description>
Returns the peer IDs of all connected peers of this MultiplayerAPI's [member network_peer].

4
doc/classes/NavigationMesh.xml
View file

@ -10,7 +10,7 @@
<method name="add_polygon">
<return type="void">
</return>
<argument index="0" name="polygon" type="PackedIntArray">
<argument index="0" name="polygon" type="PackedInt32Array">
</argument>
<description>
</description>
@ -38,7 +38,7 @@
</description>
</method>
<method name="get_polygon">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="idx" type="int">
</argument>

8
doc/classes/NavigationPolygon.xml
View file

@ -18,7 +18,7 @@
var polygon = NavigationPolygon.new()
var vertices = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
polygon.set_vertices(vertices)
var indices = PackedIntArray(0, 3, 1)
var indices = PackedInt32Array(0, 3, 1)
polygon.add_polygon(indices)
$NavigationPolygonInstance.navpoly = polygon
[/codeblock]
@ -49,7 +49,7 @@
<method name="add_polygon">
<return type="void">
</return>
<argument index="0" name="polygon" type="PackedIntArray">
<argument index="0" name="polygon" type="PackedInt32Array">
</argument>
<description>
Adds a polygon using the indices of the vertices you get when calling [method get_vertices].
@ -86,12 +86,12 @@
</description>
</method>
<method name="get_polygon">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns a [PackedIntArray] containing the indices of the vertices of a created polygon.
Returns a [PackedInt32Array] containing the indices of the vertices of a created polygon.
</description>
</method>
<method name="get_polygon_count" qualifiers="const">

17
doc/classes/PackedRealArray.xml → doc/classes/PackedFloat32Array.xml
View file

@ -1,22 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PackedRealArray" version="4.0">
<class name="PackedFloat32Array" version="4.0">
<brief_description>
A packed [Array] of reals ([float]).
A packed [Array] of 32-bit floating-point values.
</brief_description>
<description>
An [Array] specifically designed to hold floating-point values ([float]). Packs data tightly, so it saves memory for large array sizes.
An [Array] specifically designed to hold 32-bit floating-point values. Packs data tightly, so it saves memory for large array sizes.
[b]Note:[/b] This type is passed by value and not by reference.
If you need to pack 64-bit floats tightly, see [PackedFloat64Array].
</description>
<tutorials>
</tutorials>
<methods>
<method name="PackedRealArray">
<return type="PackedRealArray">
<method name="PackedFloat32Array">
<return type="PackedFloat32Array">
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
Constructs a new [PackedRealArray]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PackedFloat32Array]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
</method>
<method name="append">
@ -31,10 +32,10 @@
<method name="append_array">
<return type="void">
</return>
<argument index="0" name="array" type="PackedRealArray">
<argument index="0" name="array" type="PackedFloat32Array">
</argument>
<description>
Appends a [PackedRealArray] at the end of this array.
Appends a [PackedFloat32Array] at the end of this array.
</description>
</method>
<method name="empty">

114
doc/classes/PackedFloat64Array.xml Normal file
View file

@ -0,0 +1,114 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PackedFloat64Array" version="4.0">
<brief_description>
A packed [Array] of 64-bit floating-point values.
</brief_description>
<description>
An [Array] specifically designed to hold 64-bit floating-point values. Packs data tightly, so it saves memory for large array sizes.
[b]Note:[/b] This type is passed by value and not by reference.
If you only need to pack 32-bit floats tightly, see [PackedFloat32Array] for a more memory-friendly alternative.
</description>
<tutorials>
</tutorials>
<methods>
<method name="PackedFloat64Array">
<return type="PackedFloat64Array">
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
Constructs a new [PackedFloat64Array]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
</method>
<method name="append">
<return type="void">
</return>
<argument index="0" name="value" type="float">
</argument>
<description>
Appends an element at the end of the array (alias of [method push_back]).
</description>
</method>
<method name="append_array">
<return type="void">
</return>
<argument index="0" name="array" type="PackedFloat64Array">
</argument>
<description>
Appends a [PackedFloat64Array] at the end of this array.
</description>
</method>
<method name="empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="insert">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
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]).
</description>
</method>
<method name="invert">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="push_back">
<return type="void">
</return>
<argument index="0" name="value" type="float">
</argument>
<description>
Appends an element at the end of the array.
</description>
</method>
<method name="remove">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Removes an element from the array by index.
</description>
</method>
<method name="resize">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
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.
</description>
</method>
<method name="set">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
Changes the float at the given index.
</description>
</method>
<method name="size">
<return type="int">
</return>
<description>
Returns the size of the array.
</description>
</method>
</methods>
<constants>
</constants>
</class>

114
doc/classes/PackedInt32Array.xml Normal file
View file

@ -0,0 +1,114 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PackedInt32Array" version="4.0">
<brief_description>
A packed [Array] of 32-bit integers.
</brief_description>
<description>
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 is passed by value and not by reference.
[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].
</description>
<tutorials>
</tutorials>
<methods>
<method name="PackedInt32Array">
<return type="PackedInt32Array">
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
Constructs a new [PackedInt32Array]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
</method>
<method name="append">
<return type="void">
</return>
<argument index="0" name="integer" type="int">
</argument>
<description>
Appends an element at the end of the array (alias of [method push_back]).
</description>
</method>
<method name="append_array">
<return type="void">
</return>
<argument index="0" name="array" type="PackedInt32Array">
</argument>
<description>
Appends a [PackedInt32Array] at the end of this array.
</description>
</method>
<method name="empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="insert">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="integer" type="int">
</argument>
<description>
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]).
</description>
</method>
<method name="invert">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="push_back">
<return type="void">
</return>
<argument index="0" name="integer" type="int">
</argument>
<description>
Appends a value to the array.
</description>
</method>
<method name="remove">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Removes an element from the array by index.
</description>
</method>
<method name="resize">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
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.
</description>
</method>
<method name="set">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="integer" type="int">
</argument>
<description>
Changes the integer at the given index.
</description>
</method>
<method name="size">
<return type="int">
</return>
<description>
Returns the array size.
</description>
</method>
</methods>
<constants>
</constants>
</class>

18
doc/classes/PackedIntArray.xml → doc/classes/PackedInt64Array.xml
View file

@ -1,23 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PackedIntArray" version="4.0">
<class name="PackedInt64Array" version="4.0">
<brief_description>
A packed [Array] of integers ([int]).
A packed [Array] of 64-bit integers.
</brief_description>
<description>
An [Array] specifically designed to hold integer values ([int]). Packs data tightly, so it saves memory for large array sizes.
An [Array] specifically designed to hold 64-bit integer values. Packs data tightly, so it saves memory for large array sizes.
[b]Note:[/b] This type is passed by value and not by reference.
[b]Note:[/b] This type is limited to signed 32-bit integers, which means it can only 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.
[b]Note:[/b] This type stores signed 64-bit integers, which means it can take values in the interval [code][-2^63, 2^63 - 1][/code], i.e. [code][-9223372036854775808, 9223372036854775807][/code]. Exceeding those bounds will wrap around. If you only need to pack 32-bit integers tightly, see [PackedInt32Array] for a more memory-friendly alternative.
</description>
<tutorials>
</tutorials>
<methods>
<method name="PackedIntArray">
<return type="PackedIntArray">
<method name="PackedInt64Array">
<return type="PackedInt64Array">
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
Constructs a new [PackedIntArray]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PackedInt64Array]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
</method>
<method name="append">
@ -32,10 +32,10 @@
<method name="append_array">
<return type="void">
</return>
<argument index="0" name="array" type="PackedIntArray">
<argument index="0" name="array" type="PackedInt64Array">
</argument>
<description>
Appends a [PackedIntArray] at the end of this array.
Appends a [PackedInt64Array] at the end of this array.
</description>
</method>
<method name="empty">

2
doc/classes/PackedScene.xml
View file

@ -65,7 +65,7 @@
</method>
</methods>
<members>
<member name="_bundled" type="Dictionary" setter="_set_bundled_scene" getter="_get_bundled_scene" default="{&quot;conn_count&quot;: 0,&quot;conns&quot;: PackedIntArray( ),&quot;editable_instances&quot;: [ ],&quot;names&quot;: PackedStringArray( ),&quot;node_count&quot;: 0,&quot;node_paths&quot;: [ ],&quot;nodes&quot;: PackedIntArray( ),&quot;variants&quot;: [ ],&quot;version&quot;: 2}">
<member name="_bundled" type="Dictionary" setter="_set_bundled_scene" getter="_get_bundled_scene" default="{&quot;conn_count&quot;: 0,&quot;conns&quot;: PackedInt32Array( ),&quot;editable_instances&quot;: [ ],&quot;names&quot;: PackedStringArray( ),&quot;node_count&quot;: 0,&quot;node_paths&quot;: [ ],&quot;nodes&quot;: PackedInt32Array( ),&quot;variants&quot;: [ ],&quot;version&quot;: 2}">
A dictionary representation of the scene contents.
Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for base scene children overrides, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene.
</member>

6
doc/classes/Polygon2D.xml
View file

@ -14,7 +14,7 @@
</return>
<argument index="0" name="path" type="NodePath">
</argument>
<argument index="1" name="weights" type="PackedRealArray">
<argument index="1" name="weights" type="PackedFloat32Array">
</argument>
<description>
</description>
@ -48,7 +48,7 @@
</description>
</method>
<method name="get_bone_weights" qualifiers="const">
<return type="PackedRealArray">
<return type="PackedFloat32Array">
</return>
<argument index="0" name="index" type="int">
</argument>
@ -70,7 +70,7 @@
</return>
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="weights" type="PackedRealArray">
<argument index="1" name="weights" type="PackedFloat32Array">
</argument>
<description>
</description>

2
doc/classes/PolygonPathFinder.xml
View file

@ -72,7 +72,7 @@
</return>
<argument index="0" name="points" type="PackedVector2Array">
</argument>
<argument index="1" name="connections" type="PackedIntArray">
<argument index="1" name="connections" type="PackedInt32Array">
</argument>
<description>
</description>

2
doc/classes/SceneTree.xml
View file

@ -83,7 +83,7 @@
</description>
</method>
<method name="get_network_connected_peers" qualifiers="const">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<description>
Returns the peer IDs of all connected peers of this [SceneTree]'s [member network_peer].

28
doc/classes/String.xml
View file

@ -229,19 +229,37 @@
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PackedIntArray">
<argument index="0" name="from" type="PackedInt32Array">
</argument>
<description>
Constructs a new String from the given [PackedIntArray].
Constructs a new String from the given [PackedInt32Array].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PackedRealArray">
<argument index="0" name="from" type="PackedInt64Array">
</argument>
<description>
Constructs a new String from the given [PackedRealArray].
Constructs a new String from the given [PackedInt64Array].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PackedFloat32Array">
</argument>
<description>
Constructs a new String from the given [PackedFloat32Array].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PackedFloat64Array">
</argument>
<description>
Constructs a new String from the given [PackedFloat64Array].
</description>
</method>
<method name="String">
@ -879,7 +897,7 @@
</description>
</method>
<method name="split_floats">
<return type="PackedRealArray">
<return type="PackedFloat32Array">
</return>
<argument index="0" name="delimiter" type="String">
</argument>

4
doc/classes/SurfaceTool.xml
View file

@ -22,7 +22,7 @@
<method name="add_bones">
<return type="void">
</return>
<argument index="0" name="bones" type="PackedIntArray">
<argument index="0" name="bones" type="PackedInt32Array">
</argument>
<description>
Adds an array of bones for the next vertex to use. [code]bones[/code] must contain 4 integers.
@ -123,7 +123,7 @@
<method name="add_weights">
<return type="void">
</return>
<argument index="0" name="weights" type="PackedRealArray">
<argument index="0" name="weights" type="PackedFloat32Array">
</argument>
<description>
Specifies weight values for next vertex to use. [code]weights[/code] must contain 4 values.

4
doc/classes/TextEdit.xml
View file

@ -299,7 +299,7 @@
</description>
</method>
<method name="search" qualifiers="const">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="key" type="String">
</argument>
@ -311,7 +311,7 @@
</argument>
<description>
Perform a search inside the text. Search flags can be specified in the [enum SearchFlags] enum.
Returns an empty [code]PackedIntArray[/code] if no result was found. Otherwise, the result line and column can be accessed at indices specified in the [enum SearchResult] enum, e.g:
Returns an empty [code]PackedInt32Array[/code] if no result was found. Otherwise, the result line and column can be accessed at indices specified in the [enum SearchResult] enum, e.g:
[codeblock]
var result = search(key, flags, line, column)
if result.size() &gt; 0:

4
doc/classes/VisualServer.xml
View file

@ -1943,7 +1943,7 @@
</description>
</method>
<method name="multimesh_get_buffer" qualifiers="const">
<return type="PackedRealArray">
<return type="PackedFloat32Array">
</return>
<argument index="0" name="multimesh" type="RID">
</argument>
@ -2078,7 +2078,7 @@
</return>
<argument index="0" name="multimesh" type="RID">
</argument>
<argument index="1" name="buffer" type="PackedRealArray">
<argument index="1" name="buffer" type="PackedFloat32Array">
</argument>
<description>
</description>

2
doc/classes/VisualShader.xml
View file

@ -107,7 +107,7 @@
</description>
</method>
<method name="get_node_list" qualifiers="const">
<return type="PackedIntArray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="type" type="int" enum="VisualShader.Type">
</argument>

4
platform/iphone/game_center.mm
View file

@ -202,7 +202,7 @@ void GameCenter::request_achievement_descriptions() {
PackedStringArray titles;
PackedStringArray unachieved_descriptions;
PackedStringArray achieved_descriptions;
PackedIntArray maximum_points;
PackedInt32Array maximum_points;
Array hidden;
Array replayable;
@ -254,7 +254,7 @@ void GameCenter::request_achievements() {
if (error == nil) {
ret["result"] = "ok";
PackedStringArray names;
PackedRealArray percentages;
PackedFloat32Array percentages;
for (int i = 0; i < [achievements count]; i++) {

2
platform/iphone/in_app_store.mm
View file

@ -87,7 +87,7 @@ void InAppStore::_bind_methods() {
ret["result"] = "ok";
PackedStringArray titles;
PackedStringArray descriptions;
PackedRealArray prices;
PackedFloat32Array prices;
PackedStringArray ids;
PackedStringArray localized_prices;
PackedStringArray currency_codes;