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

doc: Sync classref with current source

Browse source 
Handle removal of Pool*Array types and other recent changes.
This commit is contained in:
Rémi Verschelde 2020-02-18 13:59:24 +01:00
parent b4d1882dc3
commit 213a85521d
112 changed files with 495 additions and 509 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/classes/@GlobalScope.xml
View file

@ -30,6 +30,9 @@
<member name="Geometry" type="Geometry" setter="" getter="">
The [Geometry] singleton.
</member>
<member name="GodotSharp" type="GodotSharp" setter="" getter="">
The [GodotSharp] singleton. Only available when using Godot's Mono build.
</member>
<member name="IP" type="IP" setter="" getter="">
The [IP] singleton.
</member>
@ -1520,25 +1523,25 @@
Variable is of type [Array].
</constant>
<constant name="TYPE_RAW_ARRAY" value="20" enum="Variant.Type">
Variable is of type [PoolByteArray].
Variable is of type [PackedByteArray].
</constant>
<constant name="TYPE_INT_ARRAY" value="21" enum="Variant.Type">
Variable is of type [PoolIntArray].
Variable is of type [PackedIntArray].
</constant>
<constant name="TYPE_REAL_ARRAY" value="22" enum="Variant.Type">
Variable is of type [PoolRealArray].
Variable is of type [PackedRealArray].
</constant>
<constant name="TYPE_STRING_ARRAY" value="23" enum="Variant.Type">
Variable is of type [PoolStringArray].
Variable is of type [PackedStringArray].
</constant>
<constant name="TYPE_VECTOR2_ARRAY" value="24" enum="Variant.Type">
Variable is of type [PoolVector2Array].
Variable is of type [PackedVector2Array].
</constant>
<constant name="TYPE_VECTOR3_ARRAY" value="25" enum="Variant.Type">
Variable is of type [PoolVector3Array].
Variable is of type [PackedVector3Array].
</constant>
<constant name="TYPE_COLOR_ARRAY" value="26" enum="Variant.Type">
Variable is of type [PoolColorArray].
Variable is of type [PackedColorArray].
</constant>
<constant name="TYPE_MAX" value="27" enum="Variant.Type">
Represents the size of the [enum Variant.Type] enum.

6
doc/classes/AStar.xml
View file

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

6
doc/classes/AStar2D.xml
View file

@ -111,7 +111,7 @@
</description>
</method>
<method name="get_id_path">
<return type="PoolIntArray">
<return type="PackedIntArray">
</return>
<argument index="0" name="from_id" type="int">
</argument>
@ -144,7 +144,7 @@
</description>
</method>
<method name="get_point_connections">
<return type="PoolIntArray">
<return type="PackedIntArray">
</return>
<argument index="0" name="id" type="int">
</argument>
@ -172,7 +172,7 @@
</description>
</method>
<method name="get_point_path">
<return type="PoolVector2Array">
<return type="PackedVector2Array">
</return>
<argument index="0" name="from_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="PoolIntArray">
<return type="PackedIntArray">
</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="PoolIntArray">
<return type="PackedIntArray">
</return>
<argument index="0" name="track_idx" type="int">
</argument>

2
doc/classes/AnimationNodeStateMachinePlayback.xml
View file

@ -23,7 +23,7 @@
</description>
</method>
<method name="get_travel_path" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns the current travel path as computed internally by the A* algorithm.

4
doc/classes/AnimationPlayer.xml
View file

@ -86,7 +86,7 @@
</description>
</method>
<method name="get_animation_list" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns the list of stored animation names.
@ -111,7 +111,7 @@
</description>
</method>
<method name="get_queue">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns a list of the animation names that are currently queued to play.

28
doc/classes/Array.xml
View file

@ -22,64 +22,64 @@
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PoolColorArray">
<argument index="0" name="from" type="PackedColorArray">
</argument>
<description>
Constructs an array from a [PoolColorArray].
Constructs an array from a [PackedColorArray].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PoolVector3Array">
<argument index="0" name="from" type="PackedVector3Array">
</argument>
<description>
Constructs an array from a [PoolVector3Array].
Constructs an array from a [PackedVector3Array].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PoolVector2Array">
<argument index="0" name="from" type="PackedVector2Array">
</argument>
<description>
Constructs an array from a [PoolVector2Array].
Constructs an array from a [PackedVector2Array].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PoolStringArray">
<argument index="0" name="from" type="PackedStringArray">
</argument>
<description>
Constructs an array from a [PoolStringArray].
Constructs an array from a [PackedStringArray].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PoolRealArray">
<argument index="0" name="from" type="PackedRealArray">
</argument>
<description>
Constructs an array from a [PoolRealArray].
Constructs an array from a [PackedRealArray].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PoolIntArray">
<argument index="0" name="from" type="PackedIntArray">
</argument>
<description>
Constructs an array from a [PoolIntArray].
Constructs an array from a [PackedIntArray].
</description>
</method>
<method name="Array">
<return type="Array">
</return>
<argument index="0" name="from" type="PoolByteArray">
<argument index="0" name="from" type="PackedByteArray">
</argument>
<description>
Constructs an array from a [PoolByteArray].
Constructs an array from a [PackedByteArray].
</description>
</method>
<method name="append">

22
doc/classes/ArrayMesh.xml
View file

@ -7,7 +7,7 @@
The [ArrayMesh] is used to construct a [Mesh] by specifying the attributes as arrays.
The most basic example is the creation of a single triangle:
[codeblock]
var vertices = PoolVector3Array()
var vertices = PackedVector3Array()
vertices.push_back(Vector3(0, 1, 0))
vertices.push_back(Vector3(1, 0, 0))
vertices.push_back(Vector3(0, 0, 1))
@ -178,7 +178,7 @@
</argument>
<argument index="1" name="offset" type="int">
</argument>
<argument index="2" name="data" type="PoolByteArray">
<argument index="2" name="data" type="PackedByteArray">
</argument>
<description>
Updates a specified region of mesh arrays on the GPU.
@ -202,31 +202,31 @@
Amount of weights/bone indices per vertex (always 4).
</constant>
<constant name="ARRAY_VERTEX" value="0" enum="ArrayType">
[PoolVector3Array], [PoolVector2Array], or [Array] of vertex positions.
[PackedVector3Array], [PackedVector2Array], or [Array] of vertex positions.
</constant>
<constant name="ARRAY_NORMAL" value="1" enum="ArrayType">
[PoolVector3Array] of vertex normals.
[PackedVector3Array] of vertex normals.
</constant>
<constant name="ARRAY_TANGENT" value="2" enum="ArrayType">
[PoolRealArray] 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.
[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.
</constant>
<constant name="ARRAY_COLOR" value="3" enum="ArrayType">
[PoolColorArray] of vertex colors.
[PackedColorArray] of vertex colors.
</constant>
<constant name="ARRAY_TEX_UV" value="4" enum="ArrayType">
[PoolVector2Array] for UV coordinates.
[PackedVector2Array] for UV coordinates.
</constant>
<constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType">
[PoolVector2Array] for second UV coordinates.
[PackedVector2Array] for second UV coordinates.
</constant>
<constant name="ARRAY_BONES" value="6" enum="ArrayType">
[PoolRealArray] or [PoolIntArray] of bone indices. Each element in groups of 4 floats.
[PackedRealArray] or [PackedIntArray] of bone indices. Each element in groups of 4 floats.
</constant>
<constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType">
[PoolRealArray] of bone weights. Each element in groups of 4 floats.
[PackedRealArray] of bone weights. Each element in groups of 4 floats.
</constant>
<constant name="ARRAY_INDEX" value="8" enum="ArrayType">
[PoolIntArray] 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.
[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.
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">

2
doc/classes/AudioStreamGeneratorPlayback.xml
View file

@ -37,7 +37,7 @@
<method name="push_buffer">
<return type="bool">
</return>
<argument index="0" name="frames" type="PoolVector2Array">
<argument index="0" name="frames" type="PackedVector2Array">
</argument>
<description>
</description>

2
doc/classes/AudioStreamSample.xml
View file

@ -22,7 +22,7 @@
</method>
</methods>
<members>
<member name="data" type="PoolByteArray" setter="set_data" getter="get_data" default="PoolByteArray( )">
<member name="data" type="PackedByteArray" setter="set_data" getter="get_data" default="PackedByteArray( )">
Contains the audio data in bytes.
[b]Note:[/b] This property expects signed PCM8 data. To convert unsigned PCM8 to signed PCM8, subtract 128 from each byte.
</member>

6
doc/classes/CPUParticles.xml
View file

@ -171,13 +171,13 @@
<member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents">
The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_BOX].
</member>
<member name="emission_colors" type="PoolColorArray" setter="set_emission_colors" getter="get_emission_colors" default="PoolColorArray( )">
<member name="emission_colors" type="PackedColorArray" setter="set_emission_colors" getter="get_emission_colors" default="PackedColorArray( )">
Sets the [Color]s to modulate particles by when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS].
</member>
<member name="emission_normals" type="PoolVector3Array" setter="set_emission_normals" getter="get_emission_normals">
<member name="emission_normals" type="PackedVector3Array" setter="set_emission_normals" getter="get_emission_normals">
Sets the direction the particles will be emitted in when using [constant EMISSION_SHAPE_DIRECTED_POINTS].
</member>
<member name="emission_points" type="PoolVector3Array" setter="set_emission_points" getter="get_emission_points" default="PoolVector3Array( )">
<member name="emission_points" type="PackedVector3Array" setter="set_emission_points" getter="get_emission_points" default="PackedVector3Array( )">
Sets the initial positions to spawn particles when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS].
</member>
<member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles.EmissionShape" default="0">

6
doc/classes/CPUParticles2D.xml
View file

@ -169,13 +169,13 @@
<member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="CPUParticles2D.DrawOrder" default="0">
Particle draw order. Uses [enum DrawOrder] values.
</member>
<member name="emission_colors" type="PoolColorArray" setter="set_emission_colors" getter="get_emission_colors">
<member name="emission_colors" type="PackedColorArray" setter="set_emission_colors" getter="get_emission_colors">
Sets the [Color]s to modulate particles by when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS].
</member>
<member name="emission_normals" type="PoolVector2Array" setter="set_emission_normals" getter="get_emission_normals">
<member name="emission_normals" type="PackedVector2Array" setter="set_emission_normals" getter="get_emission_normals">
Sets the direction the particles will be emitted in when using [constant EMISSION_SHAPE_DIRECTED_POINTS].
</member>
<member name="emission_points" type="PoolVector2Array" setter="set_emission_points" getter="get_emission_points">
<member name="emission_points" type="PackedVector2Array" setter="set_emission_points" getter="get_emission_points">
Sets the initial positions to spawn particles when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS].
</member>
<member name="emission_rect_extents" type="Vector2" setter="set_emission_rect_extents" getter="get_emission_rect_extents">

56
doc/classes/CanvasItem.xml
View file

@ -76,11 +76,11 @@
<method name="draw_colored_polygon">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
<argument index="0" name="points" type="PackedVector2Array">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<argument index="2" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )">
<argument index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array( )">
</argument>
<argument index="3" name="texture" type="Texture2D" default="null">
</argument>
@ -88,7 +88,7 @@
</argument>
<argument index="5" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="6" name="specular_shinness" type="Color" default="Color( 1, 1, 1, 1 )">
<argument index="6" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="7" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
@ -118,17 +118,17 @@
</return>
<argument index="0" name="mesh" type="Mesh">
</argument>
<argument index="1" name="texture" type="Texture2D" default="null">
<argument index="1" name="texture" type="Texture2D">
</argument>
<argument index="2" name="normal_map" type="Texture2D" default="null">
</argument>
<argument index="3" name="specular_map" type="Texture2D" default="Color( 1, 1, 1, 1 )">
<argument index="3" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="4" name="transform" type="Color" default="Transform2D( 1, 0, 0, 1, 0, 0 )">
<argument index="4" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="5" name="modulate" type="Transform2D" default="Color( 1, 1, 1, 1 )">
<argument index="5" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )">
</argument>
<argument index="6" name="specular_shinness" type="Color" default="Color( 1, 1, 1, 1 )">
<argument index="6" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="7" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
@ -141,7 +141,7 @@
<method name="draw_multiline">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
<argument index="0" name="points" type="PackedVector2Array">
</argument>
<argument index="1" name="color" type="Color">
</argument>
@ -154,9 +154,9 @@
<method name="draw_multiline_colors">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
<argument index="0" name="points" type="PackedVector2Array">
</argument>
<argument index="1" name="colors" type="PoolColorArray">
<argument index="1" name="colors" type="PackedColorArray">
</argument>
<argument index="2" name="width" type="float" default="1.0">
</argument>
@ -169,13 +169,13 @@
</return>
<argument index="0" name="multimesh" type="MultiMesh">
</argument>
<argument index="1" name="texture" type="Texture2D" default="null">
<argument index="1" name="texture" type="Texture2D">
</argument>
<argument index="2" name="normal_map" type="Texture2D" default="null">
</argument>
<argument index="3" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="4" name="specular_shinness" type="Color" default="Color( 1, 1, 1, 1 )">
<argument index="4" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="5" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
@ -188,11 +188,11 @@
<method name="draw_polygon">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
<argument index="0" name="points" type="PackedVector2Array">
</argument>
<argument index="1" name="colors" type="PoolColorArray">
<argument index="1" name="colors" type="PackedColorArray">
</argument>
<argument index="2" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )">
<argument index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array( )">
</argument>
<argument index="3" name="texture" type="Texture2D" default="null">
</argument>
@ -200,7 +200,7 @@
</argument>
<argument index="5" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="6" name="specular_shinness" type="Color" default="Color( 1, 1, 1, 1 )">
<argument index="6" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="7" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
@ -213,7 +213,7 @@
<method name="draw_polyline">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
<argument index="0" name="points" type="PackedVector2Array">
</argument>
<argument index="1" name="color" type="Color">
</argument>
@ -226,9 +226,9 @@
<method name="draw_polyline_colors">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
<argument index="0" name="points" type="PackedVector2Array">
</argument>
<argument index="1" name="colors" type="PoolColorArray">
<argument index="1" name="colors" type="PackedColorArray">
</argument>
<argument index="2" name="width" type="float" default="1.0">
</argument>
@ -239,11 +239,11 @@
<method name="draw_primitive">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
<argument index="0" name="points" type="PackedVector2Array">
</argument>
<argument index="1" name="colors" type="PoolColorArray">
<argument index="1" name="colors" type="PackedColorArray">
</argument>
<argument index="2" name="uvs" type="PoolVector2Array">
<argument index="2" name="uvs" type="PackedVector2Array">
</argument>
<argument index="3" name="texture" type="Texture2D" default="null">
</argument>
@ -253,7 +253,7 @@
</argument>
<argument index="6" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="7" name="specular_shinness" type="Color" default="Color( 1, 1, 1, 1 )">
<argument index="7" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="8" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
@ -342,7 +342,7 @@
</argument>
<argument index="4" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="5" name="specular_shinness" type="Color" default="Color( 1, 1, 1, 1 )">
<argument index="5" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="6" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
@ -369,7 +369,7 @@
</argument>
<argument index="6" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="7" name="specular_shinness" type="Color" default="Color( 1, 1, 1, 1 )">
<argument index="7" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="8" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
@ -396,9 +396,9 @@
</argument>
<argument index="6" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="7" name="clip_uv" type="Color" default="true">
<argument index="7" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="8" name="specular_shinness" type="bool" default="Color( 1, 1, 1, 1 )">
<argument index="8" name="clip_uv" type="bool" default="true">
</argument>
<argument index="9" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>

6
doc/classes/ClassDB.xml
View file

@ -48,7 +48,7 @@
</description>
</method>
<method name="class_get_integer_constant_list" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="class" type="String">
</argument>
@ -162,14 +162,14 @@
</description>
</method>
<method name="get_class_list" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns the names of all the classes available.
</description>
</method>
<method name="get_inheriters_from_class" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="class" type="String">
</argument>

2
doc/classes/CollisionPolygon.xml
View file

@ -17,7 +17,7 @@
<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false">
If [code]true[/code], no collision will be produced.
</member>
<member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon" default="PoolVector2Array( )">
<member name="polygon" type="PackedVector2Array" setter="set_polygon" getter="get_polygon" default="PackedVector2Array( )">
Array of vertices which define the polygon.
[b]Note:[/b] The returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the [code]polygon[/code] member.
</member>

4
doc/classes/CollisionPolygon2D.xml
View file

@ -22,8 +22,8 @@
</member>
<member name="one_way_collision_margin" type="float" setter="set_one_way_collision_margin" getter="get_one_way_collision_margin" default="1.0">
</member>
<member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon" default="PoolVector2Array( )">
The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the [PoolVector2Array], not a reference.
<member name="polygon" type="PackedVector2Array" setter="set_polygon" getter="get_polygon" default="PackedVector2Array( )">
The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the [PackedVector2Array], not a reference.
</member>
</members>
<constants>

2
doc/classes/ColorPicker.xml
View file

@ -29,7 +29,7 @@
</description>
</method>
<method name="get_presets" qualifiers="const">
<return type="PoolColorArray">
<return type="PackedColorArray">
</return>
<description>
Returns the list of colors in the presets of the color picker.

4
doc/classes/ConcavePolygonShape.xml
View file

@ -10,7 +10,7 @@
</tutorials>
<methods>
<method name="get_faces" qualifiers="const">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<description>
Returns the faces (an array of triangles).
@ -19,7 +19,7 @@
<method name="set_faces">
<return type="void">
</return>
<argument index="0" name="faces" type="PoolVector3Array">
<argument index="0" name="faces" type="PackedVector3Array">
</argument>
<description>
Sets the faces (an array of triangles).

2
doc/classes/ConcavePolygonShape2D.xml
View file

@ -12,7 +12,7 @@
<methods>
</methods>
<members>
<member name="segments" type="PoolVector2Array" setter="set_segments" getter="get_segments" default="PoolVector2Array( )">
<member name="segments" type="PackedVector2Array" setter="set_segments" getter="get_segments" default="PackedVector2Array( )">
The array of points that make up the [ConcavePolygonShape2D]'s line segments.
</member>
</members>

8
doc/classes/ConfigFile.xml
View file

@ -51,7 +51,7 @@
</description>
</method>
<method name="get_section_keys" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="section" type="String">
</argument>
@ -60,7 +60,7 @@
</description>
</method>
<method name="get_sections" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns an array of all defined section identifiers.
@ -114,7 +114,7 @@
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="key" type="PoolByteArray">
<argument index="1" name="key" type="PackedByteArray">
</argument>
<description>
</description>
@ -154,7 +154,7 @@
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="key" type="PoolByteArray">
<argument index="1" name="key" type="PackedByteArray">
</argument>
<description>
</description>

2
doc/classes/ConvexPolygonShape.xml
View file

@ -11,7 +11,7 @@
<methods>
</methods>
<members>
<member name="points" type="PoolVector3Array" setter="set_points" getter="get_points" default="PoolVector3Array( )">
<member name="points" type="PackedVector3Array" setter="set_points" getter="get_points" default="PackedVector3Array( )">
The list of 3D points forming the convex polygon shape.
</member>
</members>

4
doc/classes/ConvexPolygonShape2D.xml
View file

@ -13,7 +13,7 @@
<method name="set_point_cloud">
<return type="void">
</return>
<argument index="0" name="point_cloud" type="PoolVector2Array">
<argument index="0" name="point_cloud" type="PackedVector2Array">
</argument>
<description>
Based on the set of points provided, this creates and assigns the [member points] property using the convex hull algorithm. Removing all unneeded points. See [method Geometry.convex_hull_2d] for details.
@ -21,7 +21,7 @@
</method>
</methods>
<members>
<member name="points" type="PoolVector2Array" setter="set_points" getter="get_points" default="PoolVector2Array( )">
<member name="points" type="PackedVector2Array" setter="set_points" getter="get_points" default="PackedVector2Array( )">
The polygon's list of vertices. Can be in either clockwise or counterclockwise order.
</member>
</members>

4
doc/classes/Crypto.xml
View file

@ -28,12 +28,12 @@
</tutorials>
<methods>
<method name="generate_random_bytes">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<argument index="0" name="size" type="int">
</argument>
<description>
Generates a [PoolByteArray] of cryptographically secure random bytes with given [code]size[/code].
Generates a [PackedByteArray] of cryptographically secure random bytes with given [code]size[/code].
</description>
</method>
<method name="generate_rsa">

6
doc/classes/Curve2D.xml
View file

@ -41,10 +41,10 @@
</description>
</method>
<method name="get_baked_points" qualifiers="const">
<return type="PoolVector2Array">
<return type="PackedVector2Array">
</return>
<description>
Returns the cache of points as a [PoolVector2Array].
Returns the cache of points as a [PackedVector2Array].
</description>
</method>
<method name="get_closest_offset" qualifiers="const">
@ -178,7 +178,7 @@
</description>
</method>
<method name="tessellate" qualifiers="const">
<return type="PoolVector2Array">
<return type="PackedVector2Array">
</return>
<argument index="0" name="max_stages" type="int" default="5">
</argument>

14
doc/classes/Curve3D.xml
View file

@ -41,24 +41,24 @@
</description>
</method>
<method name="get_baked_points" qualifiers="const">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<description>
Returns the cache of points as a [PoolVector3Array].
Returns the cache of points as a [PackedVector3Array].
</description>
</method>
<method name="get_baked_tilts" qualifiers="const">
<return type="PoolRealArray">
<return type="PackedRealArray">
</return>
<description>
Returns the cache of tilts as a [PoolRealArray].
Returns the cache of tilts as a [PackedRealArray].
</description>
</method>
<method name="get_baked_up_vectors" qualifiers="const">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<description>
Returns the cache of up vectors as a [PoolVector3Array].
Returns the cache of up vectors as a [PackedVector3Array].
If [member up_vector_enabled] is [code]false[/code], the cache will be empty.
</description>
</method>
@ -227,7 +227,7 @@
</description>
</method>
<method name="tessellate" qualifiers="const">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<argument index="0" name="max_stages" type="int" default="5">
</argument>

8
doc/classes/EditorExportPlugin.xml
View file

@ -10,7 +10,7 @@
<method name="_export_begin" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="features" type="PoolStringArray">
<argument index="0" name="features" type="PackedStringArray">
</argument>
<argument index="1" name="is_debug" type="bool">
</argument>
@ -34,7 +34,7 @@
</argument>
<argument index="1" name="type" type="String">
</argument>
<argument index="2" name="features" type="PoolStringArray">
<argument index="2" name="features" type="PackedStringArray">
</argument>
<description>
</description>
@ -44,7 +44,7 @@
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="file" type="PoolByteArray">
<argument index="1" name="file" type="PackedByteArray">
</argument>
<argument index="2" name="remap" type="bool">
</argument>
@ -96,7 +96,7 @@
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="tags" type="PoolStringArray">
<argument index="1" name="tags" type="PackedStringArray">
</argument>
<description>
</description>

2
doc/classes/EditorFileDialog.xml
View file

@ -84,7 +84,7 @@
</description>
</signal>
<signal name="files_selected">
<argument index="0" name="paths" type="PoolStringArray">
<argument index="0" name="paths" type="PackedStringArray">
</argument>
<description>
Emitted when multiple files are selected.

4
doc/classes/EditorFileSystem.xml
View file

@ -85,14 +85,14 @@
</description>
</signal>
<signal name="resources_reimported">
<argument index="0" name="resources" type="PoolStringArray">
<argument index="0" name="resources" type="PackedStringArray">
</argument>
<description>
Remitted if a resource is reimported.
</description>
</signal>
<signal name="resources_reload">
<argument index="0" name="resources" type="PoolStringArray">
<argument index="0" name="resources" type="PackedStringArray">
</argument>
<description>
</description>

2
doc/classes/EditorInspectorPlugin.xml
View file

@ -40,7 +40,7 @@
</return>
<argument index="0" name="label" type="String">
</argument>
<argument index="1" name="properties" type="PoolStringArray">
<argument index="1" name="properties" type="PackedStringArray">
</argument>
<argument index="2" name="editor" type="Control">
</argument>

2
doc/classes/EditorPlugin.xml
View file

@ -253,7 +253,7 @@
</description>
</method>
<method name="get_breakpoints" qualifiers="virtual">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
This is for editors that edit script-based objects. You can return a list of breakpoints in the format ([code]script:line[/code]), for example: [code]res://path_to_script.gd:25[/code].

2
doc/classes/EditorProperty.xml
View file

@ -93,7 +93,7 @@
</members>
<signals>
<signal name="multiple_properties_changed">
<argument index="0" name="properties" type="PoolStringArray">
<argument index="0" name="properties" type="PackedStringArray">
</argument>
<argument index="1" name="value" type="Array">
</argument>

8
doc/classes/EditorSettings.xml
View file

@ -50,7 +50,7 @@
</description>
</method>
<method name="get_favorites" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Gets the list of favorite files and directories for this project.
@ -76,7 +76,7 @@
</description>
</method>
<method name="get_recent_dirs" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Gets the list of recently visited folders in the file dialog for this project.
@ -126,7 +126,7 @@
<method name="set_favorites">
<return type="void">
</return>
<argument index="0" name="dirs" type="PoolStringArray">
<argument index="0" name="dirs" type="PackedStringArray">
</argument>
<description>
Sets the list of favorite files and directories for this project.
@ -159,7 +159,7 @@
<method name="set_recent_dirs">
<return type="void">
</return>
<argument index="0" name="dirs" type="PoolStringArray">
<argument index="0" name="dirs" type="PackedStringArray">
</argument>
<description>
Sets the list of recently visited folders in the file dialog for this project.

6
doc/classes/EditorSpatialGizmo.xml
View file

@ -12,7 +12,7 @@
<method name="add_collision_segments">
<return type="void">
</return>
<argument index="0" name="segments" type="PoolVector3Array">
<argument index="0" name="segments" type="PackedVector3Array">
</argument>
<description>
</description>
@ -29,7 +29,7 @@
<method name="add_handles">
<return type="void">
</return>
<argument index="0" name="handles" type="PoolVector3Array">
<argument index="0" name="handles" type="PackedVector3Array">
</argument>
<argument index="1" name="material" type="Material">
</argument>
@ -45,7 +45,7 @@
<method name="add_lines">
<return type="void">
</return>
<argument index="0" name="lines" type="PoolVector3Array">
<argument index="0" name="lines" type="PackedVector3Array">
</argument>
<argument index="1" name="material" type="Material">
</argument>

2
doc/classes/Expression.xml
View file

@ -59,7 +59,7 @@
</return>
<argument index="0" name="expression" type="String">
</argument>
<argument index="1" name="input_names" type="PoolStringArray" default="PoolStringArray( )">
<argument index="1" name="input_names" type="PackedStringArray" default="PackedStringArray( )">
</argument>
<description>
Parses the expression and returns an [enum Error] code.

14
doc/classes/File.xml
View file

@ -87,16 +87,16 @@
</description>
</method>
<method name="get_buffer" qualifiers="const">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<argument index="0" name="len" type="int">
</argument>
<description>
Returns next [code]len[/code] bytes of the file as a [PoolByteArray].
Returns next [code]len[/code] bytes of the file as a [PackedByteArray].
</description>
</method>
<method name="get_csv_line" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="delim" type="String" default="&quot;,&quot;">
</argument>
@ -252,7 +252,7 @@
</argument>
<argument index="1" name="mode_flags" type="int" enum="File.ModeFlags">
</argument>
<argument index="2" name="key" type="PoolByteArray">
<argument index="2" name="key" type="PackedByteArray">
</argument>
<description>
Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.
@ -329,7 +329,7 @@
<method name="store_buffer">
<return type="void">
</return>
<argument index="0" name="buffer" type="PoolByteArray">
<argument index="0" name="buffer" type="PackedByteArray">
</argument>
<description>
Stores the given array of bytes in the file.
@ -338,12 +338,12 @@
<method name="store_csv_line">
<return type="void">
</return>
<argument index="0" name="values" type="PoolStringArray">
<argument index="0" name="values" type="PackedStringArray">
</argument>
<argument index="1" name="delim" type="String" default="&quot;,&quot;">
</argument>
<description>
Store the given [PoolStringArray] in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter [code]delim[/code] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long.
Store the given [PackedStringArray] in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter [code]delim[/code] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long.
Text will be encoded as UTF-8.
</description>
</method>

6
doc/classes/FileDialog.xml
View file

@ -68,8 +68,8 @@
The currently selected file path of the file dialog.
</member>
<member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok" override="true" default="false" />
<member name="filters" type="PoolStringArray" setter="set_filters" getter="get_filters" default="PoolStringArray( )">
The available file type filters. For example, this shows only [code].png[/code] and [code].gd[/code] files: [code]set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))[/code].
<member name="filters" type="PackedStringArray" setter="set_filters" getter="get_filters" default="PackedStringArray( )">
The available file type filters. For example, this shows only [code].png[/code] and [code].gd[/code] files: [code]set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))[/code].
</member>
<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="FileDialog.Mode" default="4">
The dialog's open or save mode, which affects the selection behavior. See enum [code]Mode[/code] constants.
@ -98,7 +98,7 @@
</description>
</signal>
<signal name="files_selected">
<argument index="0" name="paths" type="PoolStringArray">
<argument index="0" name="paths" type="PackedStringArray">
</argument>
<description>
Emitted when the user selects multiple files.

14
doc/classes/GIProbeData.xml
View file

@ -16,13 +16,13 @@
</argument>
<argument index="2" name="octree_size" type="Vector3">
</argument>
<argument index="3" name="octree_cells" type="PoolByteArray">
<argument index="3" name="octree_cells" type="PackedByteArray">
</argument>
<argument index="4" name="data_cells" type="PoolByteArray">
<argument index="4" name="data_cells" type="PackedByteArray">
</argument>
<argument index="5" name="distance_field" type="PoolByteArray">
<argument index="5" name="distance_field" type="PackedByteArray">
</argument>
<argument index="6" name="level_counts" type="PoolIntArray">
<argument index="6" name="level_counts" type="PackedIntArray">
</argument>
<description>
</description>
@ -34,19 +34,19 @@
</description>
</method>
<method name="get_data_cells" qualifiers="const">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<description>
</description>
</method>
<method name="get_level_counts" qualifiers="const">
<return type="PoolIntArray">
<return type="PackedIntArray">
</return>
<description>
</description>
</method>
<method name="get_octree_cells" qualifiers="const">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<description>
</description>

74
doc/classes/Geometry.xml
View file

@ -51,9 +51,9 @@
</description>
</method>
<method name="clip_polygon">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<argument index="0" name="points" type="PoolVector3Array">
<argument index="0" name="points" type="PackedVector3Array">
</argument>
<argument index="1" name="plane" type="Plane">
</argument>
@ -64,9 +64,9 @@
<method name="clip_polygons_2d">
<return type="Array">
</return>
<argument index="0" name="polygon_a" type="PoolVector2Array">
<argument index="0" name="polygon_a" type="PackedVector2Array">
</argument>
<argument index="1" name="polygon_b" type="PoolVector2Array">
<argument index="1" name="polygon_b" type="PackedVector2Array">
</argument>
<description>
Clips [code]polygon_a[/code] against [code]polygon_b[/code] and returns an array of clipped polygons. This performs [constant OPERATION_DIFFERENCE] between polygons. Returns an empty array if [code]polygon_b[/code] completely overlaps [code]polygon_a[/code].
@ -76,18 +76,18 @@
<method name="clip_polyline_with_polygon_2d">
<return type="Array">
</return>
<argument index="0" name="polyline" type="PoolVector2Array">
<argument index="0" name="polyline" type="PackedVector2Array">
</argument>
<argument index="1" name="polygon" type="PoolVector2Array">
<argument index="1" name="polygon" type="PackedVector2Array">
</argument>
<description>
Clips [code]polyline[/code] against [code]polygon[/code] and returns an array of clipped polylines. This performs [constant OPERATION_DIFFERENCE] between the polyline and the polygon. This operation can be thought of as cutting a line with a closed shape.
</description>
</method>
<method name="convex_hull_2d">
<return type="PoolVector2Array">
<return type="PackedVector2Array">
</return>
<argument index="0" name="points" type="PoolVector2Array">
<argument index="0" name="points" type="PackedVector2Array">
</argument>
<description>
Given an array of [Vector2]s, returns the convex hull as a list of points in counterclockwise order. The last point is the same as the first one.
@ -96,9 +96,9 @@
<method name="exclude_polygons_2d">
<return type="Array">
</return>
<argument index="0" name="polygon_a" type="PoolVector2Array">
<argument index="0" name="polygon_a" type="PackedVector2Array">
</argument>
<argument index="1" name="polygon_b" type="PoolVector2Array">
<argument index="1" name="polygon_b" type="PackedVector2Array">
</argument>
<description>
Mutually excludes common area defined by intersection of [code]polygon_a[/code] and [code]polygon_b[/code] (see [method intersect_polygons_2d]) and returns an array of excluded polygons. This performs [constant OPERATION_XOR] between polygons. In other words, returns all but common area between polygons.
@ -158,7 +158,7 @@
</description>
</method>
<method name="get_closest_points_between_segments">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<argument index="0" name="p1" type="Vector3">
</argument>
@ -169,11 +169,11 @@
<argument index="3" name="q2" type="Vector3">
</argument>
<description>
Given the two 3D segments ([code]p1[/code], [code]p2[/code]) and ([code]q1[/code], [code]q2[/code]), finds those two points on the two segments that are closest to each other. Returns a [PoolVector3Array] that contains this point on ([code]p1[/code], [code]p2[/code]) as well the accompanying point on ([code]q1[/code], [code]q2[/code]).
Given the two 3D segments ([code]p1[/code], [code]p2[/code]) and ([code]q1[/code], [code]q2[/code]), finds those two points on the two segments that are closest to each other. Returns a [PackedVector3Array] that contains this point on ([code]p1[/code], [code]p2[/code]) as well the accompanying point on ([code]q1[/code], [code]q2[/code]).
</description>
</method>
<method name="get_closest_points_between_segments_2d">
<return type="PoolVector2Array">
<return type="PackedVector2Array">
</return>
<argument index="0" name="p1" type="Vector2">
</argument>
@ -184,7 +184,7 @@
<argument index="3" name="q2" type="Vector2">
</argument>
<description>
Given the two 2D segments ([code]p1[/code], [code]p2[/code]) and ([code]q1[/code], [code]q2[/code]), finds those two points on the two segments that are closest to each other. Returns a [PoolVector2Array] that contains this point on ([code]p1[/code], [code]p2[/code]) as well the accompanying point on ([code]q1[/code], [code]q2[/code]).
Given the two 2D segments ([code]p1[/code], [code]p2[/code]) and ([code]q1[/code], [code]q2[/code]), finds those two points on the two segments that are closest to each other. Returns a [PackedVector2Array] that contains this point on ([code]p1[/code], [code]p2[/code]) as well the accompanying point on ([code]q1[/code], [code]q2[/code]).
</description>
</method>
<method name="get_uv84_normal_bit">
@ -199,9 +199,9 @@
<method name="intersect_polygons_2d">
<return type="Array">
</return>
<argument index="0" name="polygon_a" type="PoolVector2Array">
<argument index="0" name="polygon_a" type="PackedVector2Array">
</argument>
<argument index="1" name="polygon_b" type="PoolVector2Array">
<argument index="1" name="polygon_b" type="PackedVector2Array">
</argument>
<description>
Intersects [code]polygon_a[/code] with [code]polygon_b[/code] and returns an array of intersected polygons. This performs [constant OPERATION_INTERSECTION] between polygons. In other words, returns common area shared by polygons. Returns an empty array if no intersection occurs.
@ -211,9 +211,9 @@
<method name="intersect_polyline_with_polygon_2d">
<return type="Array">
</return>
<argument index="0" name="polyline" type="PoolVector2Array">
<argument index="0" name="polyline" type="PackedVector2Array">
</argument>
<argument index="1" name="polygon" type="PoolVector2Array">
<argument index="1" name="polygon" type="PackedVector2Array">
</argument>
<description>
Intersects [code]polyline[/code] with [code]polygon[/code] and returns an array of intersected polylines. This performs [constant OPERATION_INTERSECTION] between the polyline and the polygon. This operation can be thought of as chopping a line with a closed shape.
@ -237,7 +237,7 @@
</return>
<argument index="0" name="point" type="Vector2">
</argument>
<argument index="1" name="polygon" type="PoolVector2Array">
<argument index="1" name="polygon" type="PackedVector2Array">
</argument>
<description>
Returns [code]true[/code] if [code]point[/code] is inside [code]polygon[/code] or if it's located exactly [i]on[/i] polygon's boundary, otherwise returns [code]false[/code].
@ -246,7 +246,7 @@
<method name="is_polygon_clockwise">
<return type="bool">
</return>
<argument index="0" name="polygon" type="PoolVector2Array">
<argument index="0" name="polygon" type="PackedVector2Array">
</argument>
<description>
Returns [code]true[/code] if [code]polygon[/code]'s vertices are ordered in clockwise order, otherwise returns [code]false[/code].
@ -271,7 +271,7 @@
<method name="make_atlas">
<return type="Dictionary">
</return>
<argument index="0" name="sizes" type="PoolVector2Array">
<argument index="0" name="sizes" type="PackedVector2Array">
</argument>
<description>
Given an array of [Vector2]s representing tiles, builds an atlas. The returned dictionary has two keys: [code]points[/code] is a vector of [Vector2] that specifies the positions of each tile, [code]size[/code] contains the overall size of the whole atlas as [Vector2].
@ -280,9 +280,9 @@
<method name="merge_polygons_2d">
<return type="Array">
</return>
<argument index="0" name="polygon_a" type="PoolVector2Array">
<argument index="0" name="polygon_a" type="PackedVector2Array">
</argument>
<argument index="1" name="polygon_b" type="PoolVector2Array">
<argument index="1" name="polygon_b" type="PackedVector2Array">
</argument>
<description>
Merges (combines) [code]polygon_a[/code] and [code]polygon_b[/code] and returns an array of merged polygons. This performs [constant OPERATION_UNION] between polygons.
@ -292,7 +292,7 @@
<method name="offset_polygon_2d">
<return type="Array">
</return>
<argument index="0" name="polygon" type="PoolVector2Array">
<argument index="0" name="polygon" type="PackedVector2Array">
</argument>
<argument index="1" name="delta" type="float">
</argument>
@ -307,7 +307,7 @@
<method name="offset_polyline_2d">
<return type="Array">
</return>
<argument index="0" name="polyline" type="PoolVector2Array">
<argument index="0" name="polyline" type="PackedVector2Array">
</argument>
<argument index="1" name="delta" type="float">
</argument>
@ -370,7 +370,7 @@
</description>
</method>
<method name="segment_intersects_convex">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
@ -379,11 +379,11 @@
<argument index="2" name="planes" type="Array">
</argument>
<description>
Given a convex hull defined though the [Plane]s in the array [code]planes[/code], tests if the segment ([code]from[/code], [code]to[/code]) intersects with that hull. If an intersection is found, returns a [PoolVector3Array] containing the point the intersection and the hull's normal. If no intersecion is found, an the returned array is empty.
Given a convex hull defined though the [Plane]s in the array [code]planes[/code], tests if the segment ([code]from[/code], [code]to[/code]) intersects with that hull. If an intersection is found, returns a [PackedVector3Array] containing the point the intersection and the hull's normal. If no intersecion is found, an the returned array is empty.
</description>
</method>
<method name="segment_intersects_cylinder">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
@ -394,7 +394,7 @@
<argument index="3" name="radius" type="float">
</argument>
<description>
Checks if the segment ([code]from[/code], [code]to[/code]) intersects the cylinder with height [code]height[/code] that is centered at the origin and has radius [code]radius[/code]. If no, returns an empty [PoolVector3Array]. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection.
Checks if the segment ([code]from[/code], [code]to[/code]) intersects the cylinder with height [code]height[/code] that is centered at the origin and has radius [code]radius[/code]. If no, returns an empty [PackedVector3Array]. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection.
</description>
</method>
<method name="segment_intersects_segment_2d">
@ -413,7 +413,7 @@
</description>
</method>
<method name="segment_intersects_sphere">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
@ -424,7 +424,7 @@
<argument index="3" name="sphere_radius" type="float">
</argument>
<description>
Checks if the segment ([code]from[/code], [code]to[/code]) intersects the sphere that is located at [code]sphere_position[/code] and has radius [code]sphere_radius[/code]. If no, returns an empty [PoolVector3Array]. If yes, returns a [PoolVector3Array] containing the point of intersection and the sphere's normal at the point of intersection.
Checks if the segment ([code]from[/code], [code]to[/code]) intersects the sphere that is located at [code]sphere_position[/code] and has radius [code]sphere_radius[/code]. If no, returns an empty [PackedVector3Array]. If yes, returns a [PackedVector3Array] containing the point of intersection and the sphere's normal at the point of intersection.
</description>
</method>
<method name="segment_intersects_triangle">
@ -445,21 +445,21 @@
</description>
</method>
<method name="triangulate_delaunay_2d">
<return type="PoolIntArray">
<return type="PackedIntArray">
</return>
<argument index="0" name="points" type="PoolVector2Array">
<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 [PoolIntArray] 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 [PoolIntArray] 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 [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.
</description>
</method>
<method name="triangulate_polygon">
<return type="PoolIntArray">
<return type="PackedIntArray">
</return>
<argument index="0" name="polygon" type="PoolVector2Array">
<argument index="0" name="polygon" type="PackedVector2Array">
</argument>
<description>
Triangulates the polygon specified by the points in [code]polygon[/code]. Returns a [PoolIntArray] 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 [PoolIntArray] is returned.
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.
</description>
</method>
</methods>

8
doc/classes/Gradient.xml
View file

@ -87,11 +87,11 @@
</method>
</methods>
<members>
<member name="colors" type="PoolColorArray" setter="set_colors" getter="get_colors" default="PoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )">
Gradient's colors returned as a [PoolColorArray].
<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="PoolRealArray" setter="set_offsets" getter="get_offsets" default="PoolRealArray( 0, 1 )">
Gradient's offsets returned as a [PoolRealArray].
<member name="offsets" type="PackedRealArray" setter="set_offsets" getter="get_offsets" default="PackedRealArray( 0, 1 )">
Gradient's offsets returned as a [PackedRealArray].
</member>
</members>
<constants>

10
doc/classes/HTTPClient.xml
View file

@ -55,7 +55,7 @@
</description>
</method>
<method name="get_response_headers">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns the response headers.
@ -124,7 +124,7 @@
</description>
</method>
<method name="read_response_body_chunk">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<description>
Reads one chunk from the response.
@ -137,7 +137,7 @@
</argument>
<argument index="1" name="url" type="String">
</argument>
<argument index="2" name="headers" type="PoolStringArray">
<argument index="2" name="headers" type="PackedStringArray">
</argument>
<argument index="3" name="body" type="String" default="&quot;&quot;">
</argument>
@ -160,9 +160,9 @@
</argument>
<argument index="1" name="url" type="String">
</argument>
<argument index="2" name="headers" type="PoolStringArray">
<argument index="2" name="headers" type="PackedStringArray">
</argument>
<argument index="3" name="body" type="PoolByteArray">
<argument index="3" name="body" type="PackedByteArray">
</argument>
<description>
Sends a raw request to the connected host. The URL parameter is just the part after the host, so for [code]http://somehost.com/index.php[/code], it is [code]index.php[/code].

6
doc/classes/HTTPRequest.xml
View file

@ -96,7 +96,7 @@
</return>
<argument index="0" name="url" type="String">
</argument>
<argument index="1" name="custom_headers" type="PoolStringArray" default="PoolStringArray( )">
<argument index="1" name="custom_headers" type="PackedStringArray" default="PackedStringArray( )">
</argument>
<argument index="2" name="ssl_validate_domain" type="bool" default="true">
</argument>
@ -136,9 +136,9 @@
</argument>
<argument index="1" name="response_code" type="int">
</argument>
<argument index="2" name="headers" type="PoolStringArray">
<argument index="2" name="headers" type="PackedStringArray">
</argument>
<argument index="3" name="body" type="PoolByteArray">
<argument index="3" name="body" type="PackedByteArray">
</argument>
<description>
Emitted when a request is completed.

4
doc/classes/HashingContext.xml
View file

@ -33,7 +33,7 @@
</tutorials>
<methods>
<method name="finish">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<description>
Closes the current context, and return the computed hash.
@ -51,7 +51,7 @@
<method name="update">
<return type="int" enum="Error">
</return>
<argument index="0" name="chunk" type="PoolByteArray">
<argument index="0" name="chunk" type="PackedByteArray">
</argument>
<description>
Updates the computation with the given [code]chunk[/code] of data.

2
doc/classes/HeightMapShape.xml
View file

@ -11,7 +11,7 @@
<methods>
</methods>
<members>
<member name="map_data" type="PoolRealArray" setter="set_map_data" getter="get_map_data" default="PoolRealArray( 0, 0, 0, 0 )">
<member name="map_data" type="PackedRealArray" setter="set_map_data" getter="get_map_data" default="PackedRealArray( 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">

44
doc/classes/Image.xml
View file

@ -150,7 +150,7 @@
</argument>
<argument index="3" name="format" type="int" enum="Image.Format">
</argument>
<argument index="4" name="data" type="PoolByteArray">
<argument index="4" name="data" type="PackedByteArray">
</argument>
<description>
Creates a new image of given size and format. See [enum Format] constants. Fills the image with the given raw data. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [method generate_mipmaps].
@ -236,7 +236,7 @@
</description>
</method>
<method name="get_data" qualifiers="const">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<description>
Returns the image's raw data.
@ -273,7 +273,7 @@
<argument index="1" name="y" type="int">
</argument>
<description>
Returns the color of the pixel at [code](x, y)[/code] if the image is locked. If the image is unlocked, it always returns a [Color] with the value [code](0, 0, 0, 1.0)[/code]. This is the same as [method get_pixelv], but two integer arguments instead of a Vector2 argument.
Returns the color of the pixel at [code](x, y)[/code]. This is the same as [method get_pixelv], but with two integer arguments instead of a [Vector2] argument.
</description>
</method>
<method name="get_pixelv" qualifiers="const">
@ -282,7 +282,7 @@
<argument index="0" name="src" type="Vector2">
</argument>
<description>
Returns the color of the pixel at [code]src[/code] if the image is locked. If the image is unlocked, it always returns a [Color] with the value [code](0, 0, 0, 1.0)[/code]. This is the same as [method get_pixel], but with a Vector2 argument instead of two integer arguments.
Returns the color of the pixel at [code]src[/code]. This is the same as [method get_pixel], but with a [Vector2] argument instead of two integer arguments.
</description>
</method>
<method name="get_rect" qualifiers="const">
@ -355,7 +355,7 @@
<method name="load_jpg_from_buffer">
<return type="int" enum="Error">
</return>
<argument index="0" name="buffer" type="PoolByteArray">
<argument index="0" name="buffer" type="PackedByteArray">
</argument>
<description>
Loads an image from the binary contents of a JPEG file.
@ -364,7 +364,7 @@
<method name="load_png_from_buffer">
<return type="int" enum="Error">
</return>
<argument index="0" name="buffer" type="PoolByteArray">
<argument index="0" name="buffer" type="PackedByteArray">
</argument>
<description>
Loads an image from the binary contents of a PNG file.
@ -373,19 +373,12 @@
<method name="load_webp_from_buffer">
<return type="int" enum="Error">
</return>
<argument index="0" name="buffer" type="PoolByteArray">
<argument index="0" name="buffer" type="PackedByteArray">
</argument>
<description>
Loads an image from the binary contents of a WebP file.
</description>
</method>
<method name="lock">
<return type="void">
</return>
<description>
Locks the data for reading and writing access. Sends an error to the console if the image is not locked when reading or writing a pixel.
</description>
</method>
<method name="normalmap_to_xy">
<return type="void">
</return>
@ -459,14 +452,11 @@
<argument index="2" name="color" type="Color">
</argument>
<description>
Sets the [Color] of the pixel at [code](x, y)[/code] if the image is locked. Example:
Sets the [Color] of the pixel at [code](x, y)[/code]. Example:
[codeblock]
var img = Image.new()
img.create(img_width, img_height, false, Image.FORMAT_RGBA8)
img.lock()
img.set_pixel(x, y, color) # Works
img.unlock()
img.set_pixel(x, y, color) # Does not have an effect
img.set_pixel(x, y, color)
[/codeblock]
</description>
</method>
@ -478,14 +468,11 @@
<argument index="1" name="color" type="Color">
</argument>
<description>
Sets the [Color] of the pixel at [code](dst.x, dst.y)[/code] if the image is locked. Note that the [code]dst[/code] values must be integers. Example:
Sets the [Color] of the pixel at [code](dst.x, dst.y)[/code]. Note that the [code]dst[/code] values must be integers. Example:
[codeblock]
var img = Image.new()
img.create(img_width, img_height, false, Image.FORMAT_RGBA8)
img.lock()
img.set_pixelv(Vector2(x, y), color) # Works
img.unlock()
img.set_pixelv(Vector2(x, y), color) # Does not have an effect
img.set_pixelv(Vector2(x, y), color)
[/codeblock]
</description>
</method>
@ -503,16 +490,9 @@
Converts the raw data from the sRGB colorspace to a linear scale.
</description>
</method>
<method name="unlock">
<return type="void">
</return>
<description>
Unlocks the data and prevents changes.
</description>
</method>
</methods>
<members>
<member name="data" type="Dictionary" setter="_set_data" getter="_get_data" default="{&quot;data&quot;: PoolByteArray( ),&quot;format&quot;: &quot;Lum8&quot;,&quot;height&quot;: 0,&quot;mipmaps&quot;: false,&quot;width&quot;: 0}">
<member name="data" type="Dictionary" setter="_set_data" getter="_get_data" default="{&quot;data&quot;: PackedByteArray( ),&quot;format&quot;: &quot;Lum8&quot;,&quot;height&quot;: 0,&quot;mipmaps&quot;: false,&quot;width&quot;: 0}">
Holds all of the image's color data in a given format. See [enum Format] constants.
</member>
</members>

2
doc/classes/ItemList.xml
View file

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

2
doc/classes/Line2D.xml
View file

@ -84,7 +84,7 @@
<member name="joint_mode" type="int" setter="set_joint_mode" getter="get_joint_mode" enum="Line2D.LineJointMode" default="0">
The style for the points between the start and the end.
</member>
<member name="points" type="PoolVector2Array" setter="set_points" getter="get_points" default="PoolVector2Array( )">
<member name="points" type="PackedVector2Array" setter="set_points" getter="get_points" default="PackedVector2Array( )">
The points that form the lines. The line is drawn between every point set in this array.
</member>
<member name="round_precision" type="int" setter="set_round_precision" getter="get_round_precision" default="8">

2
doc/classes/MainLoop.xml
View file

@ -46,7 +46,7 @@
<method name="_drop_files" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="files" type="PoolStringArray">
<argument index="0" name="files" type="PackedStringArray">
</argument>
<argument index="1" name="from_screen" type="int">
</argument>

8
doc/classes/Marshalls.xml
View file

@ -10,12 +10,12 @@
</tutorials>
<methods>
<method name="base64_to_raw">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<argument index="0" name="base64_str" type="String">
</argument>
<description>
Returns a decoded [PoolByteArray] corresponding to the Base64-encoded string [code]base64_str[/code].
Returns a decoded [PackedByteArray] corresponding to the Base64-encoded string [code]base64_str[/code].
</description>
</method>
<method name="base64_to_utf8">
@ -42,10 +42,10 @@
<method name="raw_to_base64">
<return type="String">
</return>
<argument index="0" name="array" type="PoolByteArray">
<argument index="0" name="array" type="PackedByteArray">
</argument>
<description>
Returns a Base64-encoded string of a given [PoolByteArray].
Returns a Base64-encoded string of a given [PackedByteArray].
</description>
</method>
<method name="utf8_to_base64">

2
doc/classes/Mesh.xml
View file

@ -49,7 +49,7 @@
</description>
</method>
<method name="get_faces" qualifiers="const">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<description>
Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle.

14
doc/classes/MeshDataTool.xml
View file

@ -57,7 +57,7 @@
</description>
</method>
<method name="get_edge_faces" qualifiers="const">
<return type="PoolIntArray">
<return type="PackedIntArray">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -160,7 +160,7 @@
</description>
</method>
<method name="get_vertex_bones" qualifiers="const">
<return type="PoolIntArray">
<return type="PackedIntArray">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -185,7 +185,7 @@
</description>
</method>
<method name="get_vertex_edges" qualifiers="const">
<return type="PoolIntArray">
<return type="PackedIntArray">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -194,7 +194,7 @@
</description>
</method>
<method name="get_vertex_faces" qualifiers="const">
<return type="PoolIntArray">
<return type="PackedIntArray">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -248,7 +248,7 @@
</description>
</method>
<method name="get_vertex_weights" qualifiers="const">
<return type="PoolRealArray">
<return type="PackedRealArray">
</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="PoolIntArray">
<argument index="1" name="bones" type="PackedIntArray">
</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="PoolRealArray">
<argument index="1" name="weights" type="PackedRealArray">
</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="PoolIntArray">
<return type="PackedIntArray">
</return>
<description>
Returns the list of item IDs in use.

13
doc/classes/MonoGCHandle.xml Normal file
View file

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="MonoGCHandle" inherits="Reference" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

10
doc/classes/MultiMesh.xml
View file

@ -105,11 +105,11 @@
</method>
</methods>
<members>
<member name="buffer" type="PoolRealArray" setter="set_buffer" getter="get_buffer" default="PoolRealArray( )">
<member name="buffer" type="PackedRealArray" setter="set_buffer" getter="get_buffer" default="PackedRealArray( )">
</member>
<member name="color_array" type="PoolColorArray" setter="_set_color_array" getter="_get_color_array">
<member name="color_array" type="PackedColorArray" setter="_set_color_array" getter="_get_color_array">
</member>
<member name="custom_data_array" type="PoolColorArray" setter="_set_custom_data_array" getter="_get_custom_data_array">
<member name="custom_data_array" type="PackedColorArray" setter="_set_custom_data_array" getter="_get_custom_data_array">
</member>
<member name="instance_count" type="int" setter="set_instance_count" getter="get_instance_count" default="0">
Number of instances that will get drawn. This clears and (re)sizes the buffers. By default, all instances are drawn but you can limit this with [member visible_instance_count].
@ -117,9 +117,9 @@
<member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh">
Mesh to be drawn.
</member>
<member name="transform_2d_array" type="PoolVector2Array" setter="_set_transform_2d_array" getter="_get_transform_2d_array">
<member name="transform_2d_array" type="PackedVector2Array" setter="_set_transform_2d_array" getter="_get_transform_2d_array">
</member>
<member name="transform_array" type="PoolVector3Array" setter="_set_transform_array" getter="_get_transform_array">
<member name="transform_array" type="PackedVector3Array" setter="_set_transform_array" getter="_get_transform_array">
</member>
<member name="transform_format" type="int" setter="set_transform_format" getter="get_transform_format" enum="MultiMesh.TransformFormat" default="0">
Format of transform used to transform mesh, either 2D or 3D.

6
doc/classes/MultiplayerAPI.xml
View file

@ -19,7 +19,7 @@
</description>
</method>
<method name="get_network_connected_peers" qualifiers="const">
<return type="PoolIntArray">
<return type="PackedIntArray">
</return>
<description>
Returns the peer IDs of all connected peers of this MultiplayerAPI's [member network_peer].
@ -65,7 +65,7 @@
<method name="send_bytes">
<return type="int" enum="Error">
</return>
<argument index="0" name="bytes" type="PoolByteArray">
<argument index="0" name="bytes" type="PackedByteArray">
</argument>
<argument index="1" name="id" type="int" default="0">
</argument>
@ -126,7 +126,7 @@
<signal name="network_peer_packet">
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="packet" type="PoolByteArray">
<argument index="1" name="packet" type="PackedByteArray">
</argument>
<description>
Emitted when this MultiplayerAPI's [member network_peer] receive a [code]packet[/code] with custom data (see [method send_bytes]). ID is the peer ID of the peer that sent the packet.

2
doc/classes/Navigation.xml
View file

@ -16,7 +16,7 @@
</description>
</method>
<method name="get_simple_path">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<argument index="0" name="start" type="Vector3">
</argument>

2
doc/classes/Navigation2D.xml
View file

@ -16,7 +16,7 @@
</description>
</method>
<method name="get_simple_path">
<return type="PoolVector2Array">
<return type="PackedVector2Array">
</return>
<argument index="0" name="start" type="Vector2">
</argument>

2
doc/classes/Navigation2DServer.xml
View file

@ -174,7 +174,7 @@
</description>
</method>
<method name="map_get_path" qualifiers="const">
<return type="PoolVector2Array">
<return type="PackedVector2Array">
</return>
<argument index="0" name="map" type="RID">
</argument>

4
doc/classes/NavigationAgent.xml
View file

@ -24,7 +24,7 @@
</description>
</method>
<method name="get_nav_path" qualifiers="const">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<description>
Returns the path from start to finish in global coordinates.
@ -34,7 +34,7 @@
<return type="int">
</return>
<description>
Returns which index the agent is currently on in the navigation path's [PoolVector3Array].
Returns which index the agent is currently on in the navigation path's [PackedVector3Array].
</description>
</method>
<method name="get_navigation" qualifiers="const">

4
doc/classes/NavigationAgent2D.xml
View file

@ -24,7 +24,7 @@
</description>
</method>
<method name="get_nav_path" qualifiers="const">
<return type="PoolVector2Array">
<return type="PackedVector2Array">
</return>
<description>
Returns the path from start to finish in global coordinates.
@ -34,7 +34,7 @@
<return type="int">
</return>
<description>
Returns which index the agent is currently on in the navigation path's [PoolVector2Array].
Returns which index the agent is currently on in the navigation path's [PackedVector2Array].
</description>
</method>
<method name="get_navigation" qualifiers="const">

8
doc/classes/NavigationMesh.xml
View file

@ -10,7 +10,7 @@
<method name="add_polygon">
<return type="void">
</return>
<argument index="0" name="polygon" type="PoolIntArray">
<argument index="0" name="polygon" type="PackedIntArray">
</argument>
<description>
</description>
@ -38,7 +38,7 @@
</description>
</method>
<method name="get_polygon">
<return type="PoolIntArray">
<return type="PackedIntArray">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -52,7 +52,7 @@
</description>
</method>
<method name="get_vertices" qualifiers="const">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<description>
</description>
@ -70,7 +70,7 @@
<method name="set_vertices">
<return type="void">
</return>
<argument index="0" name="vertices" type="PoolVector3Array">
<argument index="0" name="vertices" type="PackedVector3Array">
</argument>
<description>
</description>

32
doc/classes/NavigationPolygon.xml
View file

@ -8,7 +8,7 @@
Using [method add_outline]:
[codeblock]
var polygon = NavigationPolygon.new()
var outline = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
var outline = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
polygon.add_outline(outline)
polygon.make_polygons_from_outlines()
$NavigationPolygonInstance.navpoly = polygon
@ -16,9 +16,9 @@
Using [method add_polygon] and indices of the vertices array.
[codeblock]
var polygon = NavigationPolygon.new()
var vertices = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
var vertices = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
polygon.set_vertices(vertices)
var indices = PoolIntArray(0, 3, 1)
var indices = PackedIntArray(0, 3, 1)
polygon.add_polygon(indices)
$NavigationPolygonInstance.navpoly = polygon
[/codeblock]
@ -29,27 +29,27 @@
<method name="add_outline">
<return type="void">
</return>
<argument index="0" name="outline" type="PoolVector2Array">
<argument index="0" name="outline" type="PackedVector2Array">
</argument>
<description>
Appends a [PoolVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines. You have to call [method make_polygons_from_outlines] in order for this array to be converted to polygons that the engine will use.
Appends a [PackedVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines. You have to call [method make_polygons_from_outlines] in order for this array to be converted to polygons that the engine will use.
</description>
</method>
<method name="add_outline_at_index">
<return type="void">
</return>
<argument index="0" name="outline" type="PoolVector2Array">
<argument index="0" name="outline" type="PackedVector2Array">
</argument>
<argument index="1" name="index" type="int">
</argument>
<description>
Adds a [PoolVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. You have to call [method make_polygons_from_outlines] in order for this array to be converted to polygons that the engine will use.
Adds a [PackedVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. You have to call [method make_polygons_from_outlines] in order for this array to be converted to polygons that the engine will use.
</description>
</method>
<method name="add_polygon">
<return type="void">
</return>
<argument index="0" name="polygon" type="PoolIntArray">
<argument index="0" name="polygon" type="PackedIntArray">
</argument>
<description>
Adds a polygon using the indices of the vertices you get when calling [method get_vertices].
@ -70,12 +70,12 @@
</description>
</method>
<method name="get_outline" qualifiers="const">
<return type="PoolVector2Array">
<return type="PackedVector2Array">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns a [PoolVector2Array] containing the vertices of an outline that was created in the editor or by script.
Returns a [PackedVector2Array] containing the vertices of an outline that was created in the editor or by script.
</description>
</method>
<method name="get_outline_count" qualifiers="const">
@ -86,12 +86,12 @@
</description>
</method>
<method name="get_polygon">
<return type="PoolIntArray">
<return type="PackedIntArray">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns a [PoolIntArray] containing the indices of the vertices of a created polygon.
Returns a [PackedIntArray] containing the indices of the vertices of a created polygon.
</description>
</method>
<method name="get_polygon_count" qualifiers="const">
@ -102,10 +102,10 @@
</description>
</method>
<method name="get_vertices" qualifiers="const">
<return type="PoolVector2Array">
<return type="PackedVector2Array">
</return>
<description>
Returns a [PoolVector2Array] containing all the vertices being used to create the polygons.
Returns a [PackedVector2Array] containing all the vertices being used to create the polygons.
</description>
</method>
<method name="make_polygons_from_outlines">
@ -129,7 +129,7 @@
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="outline" type="PoolVector2Array">
<argument index="1" name="outline" type="PackedVector2Array">
</argument>
<description>
Changes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update.
@ -138,7 +138,7 @@
<method name="set_vertices">
<return type="void">
</return>
<argument index="0" name="vertices" type="PoolVector2Array">
<argument index="0" name="vertices" type="PackedVector2Array">
</argument>
<description>
Sets the vertices that can be then indexed to create polygons with the [method add_polygon] method.

2
doc/classes/NavigationServer.xml
View file

@ -174,7 +174,7 @@
</description>
</method>
<method name="map_get_path" qualifiers="const">
<return type="PoolVector3Array">
<return type="PackedVector3Array">
</return>
<argument index="0" name="map" type="RID">
</argument>

17
doc/classes/OS.xml
View file

@ -93,7 +93,7 @@
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="arguments" type="PoolStringArray">
<argument index="1" name="arguments" type="PackedStringArray">
</argument>
<argument index="2" name="blocking" type="bool" default="true">
</argument>
@ -150,14 +150,14 @@
</description>
</method>
<method name="get_cmdline_args">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns the command line arguments passed to the engine.
</description>
</method>
<method name="get_connected_midi_inputs">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns an array of MIDI device names.
@ -200,13 +200,6 @@
The returned Dictionary's values will be the same as [method get_datetime], with the exception of Daylight Savings Time as it cannot be determined from the epoch.
</description>
</method>
<method name="get_dynamic_memory_usage" qualifiers="const">
<return type="int">
</return>
<description>
Returns the total amount of dynamic memory used (only works in debug).
</description>
</method>
<method name="get_environment" qualifiers="const">
<return type="String">
</return>
@ -224,7 +217,7 @@
</description>
</method>
<method name="get_granted_permissions" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
With this function you can get the list of dangerous permissions that have been granted to the Android application.
@ -734,7 +727,7 @@
<method name="print_resources_by_type">
<return type="void">
</return>
<argument index="0" name="types" type="PoolStringArray">
<argument index="0" name="types" type="PackedStringArray">
</argument>
<description>
Shows the number of resources loaded by the game of the given types.

8
doc/classes/Object.xml
View file

@ -251,10 +251,10 @@
</description>
</method>
<method name="get_meta_list" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns the object's metadata as a [PoolStringArray].
Returns the object's metadata as a [PackedStringArray].
</description>
</method>
<method name="get_method_list" qualifiers="const">
@ -273,7 +273,7 @@
</description>
</method>
<method name="get_script" qualifiers="const">
<return type="Reference">
<return type="Variant">
</return>
<description>
Returns the object's [Script] instance, or [code]null[/code] if none is assigned.
@ -456,7 +456,7 @@
<method name="set_script">
<return type="void">
</return>
<argument index="0" name="script" type="Reference">
<argument index="0" name="script" type="Variant">
</argument>
<description>
Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality.

2
doc/classes/OccluderPolygon2D.xml
View file

@ -17,7 +17,7 @@
<member name="cull_mode" type="int" setter="set_cull_mode" getter="get_cull_mode" enum="OccluderPolygon2D.CullMode" default="0">
The culling mode to use.
</member>
<member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon" default="PoolVector2Array( )">
<member name="polygon" type="PackedVector2Array" setter="set_polygon" getter="get_polygon" default="PackedVector2Array( )">
A [Vector2] array with the index for polygon's vertices positions.
[b]Note:[/b] The returned value is a copy of the underlying array, rather than a reference.
</member>

30
doc/classes/PoolByteArray.xml → doc/classes/PackedByteArray.xml
View file

@ -1,22 +1,22 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolByteArray" version="4.0">
<class name="PackedByteArray" version="4.0">
<brief_description>
A pooled [Array] of bytes.
A packed [Array] of bytes.
</brief_description>
<description>
An [Array] specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory.
An [Array] specifically designed to hold bytes. Packs data tightly, so it saves memory for large array sizes.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>
</tutorials>
<methods>
<method name="PoolByteArray">
<return type="PoolByteArray">
<method name="PackedByteArray">
<return type="PackedByteArray">
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
Constructs a new [PoolByteArray]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PackedByteArray]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
</method>
<method name="append">
@ -27,30 +27,30 @@
</description>
</method>
<method name="append_array">
<argument index="0" name="array" type="PoolByteArray">
<argument index="0" name="array" type="PackedByteArray">
</argument>
<description>
Appends a [PoolByteArray] at the end of this array.
Appends a [PackedByteArray] at the end of this array.
</description>
</method>
<method name="compress">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<argument index="0" name="compression_mode" type="int" default="0">
</argument>
<description>
Returns a new [PoolByteArray] with the data compressed. Set the compression mode using one of [enum File.CompressionMode]'s constants.
Returns a new [PackedByteArray] with the data compressed. Set the compression mode using one of [enum File.CompressionMode]'s constants.
</description>
</method>
<method name="decompress">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<argument index="0" name="buffer_size" type="int">
</argument>
<argument index="1" name="compression_mode" type="int" default="0">
</argument>
<description>
Returns a new [PoolByteArray] with the data decompressed. Set [code]buffer_size[/code] to the size of the uncompressed data. Set the compression mode using one of [enum File.CompressionMode]'s constants.
Returns a new [PackedByteArray] with the data decompressed. Set [code]buffer_size[/code] to the size of the uncompressed data. Set the compression mode using one of [enum File.CompressionMode]'s constants.
</description>
</method>
<method name="empty">
@ -80,7 +80,7 @@
<description>
Returns a hexadecimal representation of this array as a [String].
[codeblock]
var array = PoolByteArray([11, 46, 255])
var array = PackedByteArray([11, 46, 255])
print(array.hex_encode()) # Prints: 0b2eff
[/codeblock]
</description>
@ -139,14 +139,14 @@
</description>
</method>
<method name="subarray">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<argument index="0" name="from" type="int">
</argument>
<argument index="1" name="to" type="int">
</argument>
<description>
Returns the slice of the [PoolByteArray] between indices (inclusive) as a new [PoolByteArray]. Any negative index is considered to be from the end of the array.
Returns the slice of the [PackedByteArray] between indices (inclusive) as a new [PackedByteArray]. Any negative index is considered to be from the end of the array.
</description>
</method>
</methods>

16
doc/classes/PoolColorArray.xml → doc/classes/PackedColorArray.xml
View file

@ -1,22 +1,22 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolColorArray" version="4.0">
<class name="PackedColorArray" version="4.0">
<brief_description>
A pooled [Array] of [Color].
A packed [Array] of [Color]s.
</brief_description>
<description>
An [Array] specifically designed to hold [Color]. Optimized for memory usage, does not fragment the memory.
An [Array] specifically designed to hold [Color]. Packs data tightly, so it saves memory for large array sizes.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>
</tutorials>
<methods>
<method name="PoolColorArray">
<return type="PoolColorArray">
<method name="PackedColorArray">
<return type="PackedColorArray">
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
Constructs a new [PoolColorArray]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PackedColorArray]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
</method>
<method name="append">
@ -27,10 +27,10 @@
</description>
</method>
<method name="append_array">
<argument index="0" name="array" type="PoolColorArray">
<argument index="0" name="array" type="PackedColorArray">
</argument>
<description>
Appends a [PoolColorArray] at the end of this array.
Appends a [PackedColorArray] at the end of this array.
</description>
</method>
<method name="empty">

2
doc/classes/PackedDataContainer.xml
View file

@ -23,7 +23,7 @@
</method>
</methods>
<members>
<member name="__data__" type="PoolByteArray" setter="_set_data" getter="_get_data" default="PoolByteArray( )">
<member name="__data__" type="PackedByteArray" setter="_set_data" getter="_get_data" default="PackedByteArray( )">
</member>
</members>
<constants>

20
doc/classes/PoolIntArray.xml → doc/classes/PackedIntArray.xml
View file

@ -1,23 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolIntArray" version="4.0">
<class name="PackedIntArray" version="4.0">
<brief_description>
A pooled [Array] of integers ([int]).
A packed [Array] of integers ([int]).
</brief_description>
<description>
An [Array] specifically designed to hold integer values ([int]). Optimized for memory usage, does not fragment the memory.
An [Array] specifically designed to hold integer values ([int]). 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.
</description>
<tutorials>
</tutorials>
<methods>
<method name="PoolIntArray">
<return type="PoolIntArray">
<method name="PackedIntArray">
<return type="PackedIntArray">
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
Constructs a new [PoolIntArray]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PackedIntArray]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
</method>
<method name="append">
@ -28,10 +28,10 @@
</description>
</method>
<method name="append_array">
<argument index="0" name="array" type="PoolIntArray">
<argument index="0" name="array" type="PackedIntArray">
</argument>
<description>
Appends a [PoolIntArray] at the end of this array.
Appends a [PackedIntArray] at the end of this array.
</description>
</method>
<method name="empty">
@ -49,7 +49,7 @@
<argument index="1" name="integer" type="int">
</argument>
<description>
Inserts a new int at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
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">
@ -84,7 +84,7 @@
<argument index="1" name="integer" type="int">
</argument>
<description>
Changes the int at the given index.
Changes the integer at the given index.
</description>
</method>
<method name="size">

16
doc/classes/PoolRealArray.xml → doc/classes/PackedRealArray.xml
View file

@ -1,22 +1,22 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolRealArray" version="4.0">
<class name="PackedRealArray" version="4.0">
<brief_description>
A pooled [Array] of reals ([float]).
A packed [Array] of reals ([float]).
</brief_description>
<description>
An [Array] specifically designed to hold floating-point values ([float]). Optimized for memory usage, does not fragment the memory.
An [Array] specifically designed to hold floating-point values ([float]). Packs data tightly, so it saves memory for large array sizes.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>
</tutorials>
<methods>
<method name="PoolRealArray">
<return type="PoolRealArray">
<method name="PackedRealArray">
<return type="PackedRealArray">
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
Constructs a new [PoolRealArray]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PackedRealArray]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
</method>
<method name="append">
@ -27,10 +27,10 @@
</description>
</method>
<method name="append_array">
<argument index="0" name="array" type="PoolRealArray">
<argument index="0" name="array" type="PackedRealArray">
</argument>
<description>
Appends a [PoolRealArray] at the end of this array.
Appends a [PackedRealArray] 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;: PoolIntArray( ),&quot;editable_instances&quot;: [ ],&quot;names&quot;: PoolStringArray( ),&quot;node_count&quot;: 0,&quot;node_paths&quot;: [ ],&quot;nodes&quot;: PoolIntArray( ),&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;: 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}">
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>

25
doc/classes/PoolStringArray.xml → doc/classes/PackedStringArray.xml
View file

@ -1,22 +1,22 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolStringArray" version="4.0">
<class name="PackedStringArray" version="4.0">
<brief_description>
A pooled [Array] of [String].
A packed [Array] of [String]s.
</brief_description>
<description>
An [Array] specifically designed to hold [String]s. Optimized for memory usage, does not fragment the memory.
An [Array] specifically designed to hold [String]s. Packs data tightly, so it saves memory for large array sizes.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>
</tutorials>
<methods>
<method name="PoolStringArray">
<return type="PoolStringArray">
<method name="PackedStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
Constructs a new [PoolStringArray]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PackedStringArray]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
</method>
<method name="append">
@ -27,10 +27,10 @@
</description>
</method>
<method name="append_array">
<argument index="0" name="array" type="PoolStringArray">
<argument index="0" name="array" type="PackedStringArray">
</argument>
<description>
Appends a [PoolStringArray] at the end of this array.
Appends a [PackedStringArray] at the end of this array.
</description>
</method>
<method name="empty">
@ -56,15 +56,6 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="join">
<return type="String">
</return>
<argument index="0" name="delimiter" type="String">
</argument>
<description>
Returns a [String] with each element of the array joined with the given [code]delimiter[/code].
</description>
</method>
<method name="push_back">
<argument index="0" name="string" type="String">
</argument>

16
doc/classes/PoolVector2Array.xml → doc/classes/PackedVector2Array.xml
View file

@ -1,22 +1,22 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolVector2Array" version="4.0">
<class name="PackedVector2Array" version="4.0">
<brief_description>
A pooled [Array] of [Vector2].
A packed [Array] of [Vector2]s.
</brief_description>
<description>
An [Array] specifically designed to hold [Vector2]. Optimized for memory usage, does not fragment the memory.
An [Array] specifically designed to hold [Vector2]. Packs data tightly, so it saves memory for large array sizes.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>
</tutorials>
<methods>
<method name="PoolVector2Array">
<return type="PoolVector2Array">
<method name="PackedVector2Array">
<return type="PackedVector2Array">
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
Constructs a new [PoolVector2Array]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PackedVector2Array]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
</method>
<method name="append">
@ -27,10 +27,10 @@
</description>
</method>
<method name="append_array">
<argument index="0" name="array" type="PoolVector2Array">
<argument index="0" name="array" type="PackedVector2Array">
</argument>
<description>
Appends a [PoolVector2Array] at the end of this array.
Appends a [PackedVector2Array] at the end of this array.
</description>
</method>
<method name="empty">

16
doc/classes/PoolVector3Array.xml → doc/classes/PackedVector3Array.xml
View file

@ -1,22 +1,22 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolVector3Array" version="4.0">
<class name="PackedVector3Array" version="4.0">
<brief_description>
A pooled [Array] of [Vector3].
A packed [Array] of [Vector3]s.
</brief_description>
<description>
An [Array] specifically designed to hold [Vector3]. Optimized for memory usage, does not fragment the memory.
An [Array] specifically designed to hold [Vector3]. Packs data tightly, so it saves memory for large array sizes.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>
</tutorials>
<methods>
<method name="PoolVector3Array">
<return type="PoolVector3Array">
<method name="PackedVector3Array">
<return type="PackedVector3Array">
</return>
<argument index="0" name="from" type="Array">
</argument>
<description>
Constructs a new [PoolVector3Array]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PackedVector3Array]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
</method>
<method name="append">
@ -27,10 +27,10 @@
</description>
</method>
<method name="append_array">
<argument index="0" name="array" type="PoolVector3Array">
<argument index="0" name="array" type="PackedVector3Array">
</argument>
<description>
Appends a [PoolVector3Array] at the end of this array.
Appends a [PackedVector3Array] at the end of this array.
</description>
</method>
<method name="empty">

4
doc/classes/PacketPeer.xml
View file

@ -17,7 +17,7 @@
</description>
</method>
<method name="get_packet">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<description>
Gets a raw packet.
@ -43,7 +43,7 @@
<method name="put_packet">
<return type="int" enum="Error">
</return>
<argument index="0" name="buffer" type="PoolByteArray">
<argument index="0" name="buffer" type="PackedByteArray">
</argument>
<description>
Sends a raw packet.

54
doc/classes/Performance.xml
View file

@ -37,82 +37,76 @@
<constant name="MEMORY_STATIC" value="3" enum="Monitor">
Static memory currently used, in bytes. Not available in release builds.
</constant>
<constant name="MEMORY_DYNAMIC" value="4" enum="Monitor">
Dynamic memory currently used, in bytes. Not available in release builds.
</constant>
<constant name="MEMORY_STATIC_MAX" value="5" enum="Monitor">
<constant name="MEMORY_STATIC_MAX" value="4" enum="Monitor">
Available static memory. Not available in release builds.
</constant>
<constant name="MEMORY_DYNAMIC_MAX" value="6" enum="Monitor">
Available dynamic memory. Not available in release builds.
</constant>
<constant name="MEMORY_MESSAGE_BUFFER_MAX" value="7" enum="Monitor">
<constant name="MEMORY_MESSAGE_BUFFER_MAX" value="5" enum="Monitor">
Largest amount of memory the message queue buffer has used, in bytes. The message queue is used for deferred functions calls and notifications.
</constant>
<constant name="OBJECT_COUNT" value="8" enum="Monitor">
<constant name="OBJECT_COUNT" value="6" enum="Monitor">
Number of objects currently instanced (including nodes).
</constant>
<constant name="OBJECT_RESOURCE_COUNT" value="9" enum="Monitor">
<constant name="OBJECT_RESOURCE_COUNT" value="7" enum="Monitor">
Number of resources currently used.
</constant>
<constant name="OBJECT_NODE_COUNT" value="10" enum="Monitor">
<constant name="OBJECT_NODE_COUNT" value="8" enum="Monitor">
Number of nodes currently instanced in the scene tree. This also includes the root node.
</constant>
<constant name="OBJECT_ORPHAN_NODE_COUNT" value="11" enum="Monitor">
<constant name="OBJECT_ORPHAN_NODE_COUNT" value="9" enum="Monitor">
Number of orphan nodes, i.e. nodes which are not parented to a node of the scene tree.
</constant>
<constant name="RENDER_OBJECTS_IN_FRAME" value="12" enum="Monitor">
<constant name="RENDER_OBJECTS_IN_FRAME" value="10" enum="Monitor">
3D objects drawn per frame.
</constant>
<constant name="RENDER_VERTICES_IN_FRAME" value="13" enum="Monitor">
<constant name="RENDER_VERTICES_IN_FRAME" value="11" enum="Monitor">
Vertices drawn per frame. 3D only.
</constant>
<constant name="RENDER_MATERIAL_CHANGES_IN_FRAME" value="14" enum="Monitor">
<constant name="RENDER_MATERIAL_CHANGES_IN_FRAME" value="12" enum="Monitor">
Material changes per frame. 3D only.
</constant>
<constant name="RENDER_SHADER_CHANGES_IN_FRAME" value="15" enum="Monitor">
<constant name="RENDER_SHADER_CHANGES_IN_FRAME" value="13" enum="Monitor">
Shader changes per frame. 3D only.
</constant>
<constant name="RENDER_SURFACE_CHANGES_IN_FRAME" value="16" enum="Monitor">
<constant name="RENDER_SURFACE_CHANGES_IN_FRAME" value="14" enum="Monitor">
Render surface changes per frame. 3D only.
</constant>
<constant name="RENDER_DRAW_CALLS_IN_FRAME" value="17" enum="Monitor">
<constant name="RENDER_DRAW_CALLS_IN_FRAME" value="15" enum="Monitor">
Draw calls per frame. 3D only.
</constant>
<constant name="RENDER_VIDEO_MEM_USED" value="18" enum="Monitor">
<constant name="RENDER_VIDEO_MEM_USED" value="16" enum="Monitor">
The amount of video memory used, i.e. texture and vertex memory combined.
</constant>
<constant name="RENDER_TEXTURE_MEM_USED" value="19" enum="Monitor">
<constant name="RENDER_TEXTURE_MEM_USED" value="17" enum="Monitor">
The amount of texture memory used.
</constant>
<constant name="RENDER_VERTEX_MEM_USED" value="20" enum="Monitor">
<constant name="RENDER_VERTEX_MEM_USED" value="18" enum="Monitor">
The amount of vertex memory used.
</constant>
<constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="21" enum="Monitor">
<constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="19" enum="Monitor">
Unimplemented in the GLES2 rendering backend, always returns 0.
</constant>
<constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="22" enum="Monitor">
<constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="20" enum="Monitor">
Number of active [RigidBody2D] nodes in the game.
</constant>
<constant name="PHYSICS_2D_COLLISION_PAIRS" value="23" enum="Monitor">
<constant name="PHYSICS_2D_COLLISION_PAIRS" value="21" enum="Monitor">
Number of collision pairs in the 2D physics engine.
</constant>
<constant name="PHYSICS_2D_ISLAND_COUNT" value="24" enum="Monitor">
<constant name="PHYSICS_2D_ISLAND_COUNT" value="22" enum="Monitor">
Number of islands in the 2D physics engine.
</constant>
<constant name="PHYSICS_3D_ACTIVE_OBJECTS" value="25" enum="Monitor">
<constant name="PHYSICS_3D_ACTIVE_OBJECTS" value="23" enum="Monitor">
Number of active [RigidBody] and [VehicleBody] nodes in the game.
</constant>
<constant name="PHYSICS_3D_COLLISION_PAIRS" value="26" enum="Monitor">
<constant name="PHYSICS_3D_COLLISION_PAIRS" value="24" enum="Monitor">
Number of collision pairs in the 3D physics engine.
</constant>
<constant name="PHYSICS_3D_ISLAND_COUNT" value="27" enum="Monitor">
<constant name="PHYSICS_3D_ISLAND_COUNT" value="25" enum="Monitor">
Number of islands in the 3D physics engine.
</constant>
<constant name="AUDIO_OUTPUT_LATENCY" value="28" enum="Monitor">
<constant name="AUDIO_OUTPUT_LATENCY" value="26" enum="Monitor">
Output latency of the [AudioServer].
</constant>
<constant name="MONITOR_MAX" value="29" enum="Monitor">
<constant name="MONITOR_MAX" value="27" enum="Monitor">
Represents the size of the [enum Monitor] enum.
</constant>
</constants>

14
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="PoolRealArray">
<argument index="1" name="weights" type="PackedRealArray">
</argument>
<description>
</description>
@ -48,7 +48,7 @@
</description>
</method>
<method name="get_bone_weights" qualifiers="const">
<return type="PoolRealArray">
<return type="PackedRealArray">
</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="PoolRealArray">
<argument index="1" name="weights" type="PackedRealArray">
</argument>
<description>
</description>
@ -98,9 +98,9 @@
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset" default="Vector2( 0, 0 )">
The offset applied to each vertex.
</member>
<member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon" default="PoolVector2Array( )">
<member name="polygon" type="PackedVector2Array" setter="set_polygon" getter="get_polygon" default="PackedVector2Array( )">
The polygon's list of vertices. The final point will be connected to the first.
[b]Note:[/b] This returns a copy of the [PoolVector2Array] rather than a reference.
[b]Note:[/b] This returns a copy of the [PackedVector2Array] rather than a reference.
</member>
<member name="polygons" type="Array" setter="set_polygons" getter="get_polygons" default="[ ]">
</member>
@ -127,10 +127,10 @@
<member name="texture_scale" type="Vector2" setter="set_texture_scale" getter="get_texture_scale" default="Vector2( 1, 1 )">
Amount to multiply the [code]uv[/code] coordinates when using a [code]texture[/code]. Larger values make the texture smaller, and vice versa.
</member>
<member name="uv" type="PoolVector2Array" setter="set_uv" getter="get_uv" default="PoolVector2Array( )">
<member name="uv" type="PackedVector2Array" setter="set_uv" getter="get_uv" default="PackedVector2Array( )">
Texture coordinates for each vertex of the polygon. There should be one [code]uv[/code] per polygon vertex. If there are fewer, undefined vertices will use [code](0, 0)[/code].
</member>
<member name="vertex_colors" type="PoolColorArray" setter="set_vertex_colors" getter="get_vertex_colors" default="PoolColorArray( )">
<member name="vertex_colors" type="PackedColorArray" setter="set_vertex_colors" getter="get_vertex_colors" default="PackedColorArray( )">
Color for each vertex. Colors are interpolated between vertices, resulting in smooth gradients. There should be one per polygon vertex. If there are fewer, undefined vertices will use [code]color[/code].
</member>
</members>

8
doc/classes/PolygonPathFinder.xml
View file

@ -8,7 +8,7 @@
</tutorials>
<methods>
<method name="find_path">
<return type="PoolVector2Array">
<return type="PackedVector2Array">
</return>
<argument index="0" name="from" type="Vector2">
</argument>
@ -32,7 +32,7 @@
</description>
</method>
<method name="get_intersections" qualifiers="const">
<return type="PoolVector2Array">
<return type="PackedVector2Array">
</return>
<argument index="0" name="from" type="Vector2">
</argument>
@ -70,9 +70,9 @@
<method name="setup">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
<argument index="0" name="points" type="PackedVector2Array">
</argument>
<argument index="1" name="connections" type="PoolIntArray">
<argument index="1" name="connections" type="PackedIntArray">
</argument>
<description>
</description>

14
doc/classes/ProjectSettings.xml
View file

@ -469,7 +469,7 @@
<member name="editor/script_templates_search_path" type="String" setter="" getter="" default="&quot;res://script_templates&quot;">
Search path for project-specific script templates. Script templates will be search both in the editor-specific path and in this project-specific path.
</member>
<member name="editor/search_in_file_extensions" type="PoolStringArray" setter="" getter="" default="PoolStringArray( &quot;gd&quot;, &quot;shader&quot; )">
<member name="editor/search_in_file_extensions" type="PackedStringArray" setter="" getter="" default="PackedStringArray( &quot;gd&quot;, &quot;shader&quot; )">
Text-based file extensions to include in the script editor's "Find in Files" feature. You can add e.g. [code]tscn[/code] if you wish to also parse your scene files, especially if you use built-in scripts which are serialized in the scene files.
</member>
<member name="gui/common/default_scroll_deadzone" type="int" setter="" getter="" default="0">
@ -815,6 +815,18 @@
<member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter="" default="60">
This is used by servers when used in multi-threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number.
</member>
<member name="mono/debugger_agent/port" type="int" setter="" getter="" default="23685">
</member>
<member name="mono/debugger_agent/wait_for_debugger" type="bool" setter="" getter="" default="false">
</member>
<member name="mono/debugger_agent/wait_timeout" type="int" setter="" getter="" default="3000">
</member>
<member name="mono/profiler/args" type="String" setter="" getter="" default="&quot;log:calls,alloc,sample,output=output.mlpd&quot;">
</member>
<member name="mono/profiler/enabled" type="bool" setter="" getter="" default="false">
</member>
<member name="mono/unhandled_exception_policy" type="int" setter="" getter="" default="0">
</member>
<member name="network/limits/debugger_stdout/max_chars_per_second" type="int" setter="" getter="" default="2048">
Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection.
</member>

2
doc/classes/ResourceFormatLoader.xml
View file

@ -24,7 +24,7 @@
</description>
</method>
<method name="get_recognized_extensions" qualifiers="virtual">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Gets the list of extensions for files this loader is able to read.

2
doc/classes/ResourceFormatSaver.xml
View file

@ -11,7 +11,7 @@
</tutorials>
<methods>
<method name="get_recognized_extensions" qualifiers="virtual">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="resource" type="Resource">
</argument>

4
doc/classes/ResourceLoader.xml
View file

@ -24,7 +24,7 @@
</description>
</method>
<method name="get_dependencies">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="path" type="String">
</argument>
@ -33,7 +33,7 @@
</description>
</method>
<method name="get_recognized_extensions_for_type">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="type" type="String">
</argument>

2
doc/classes/ResourcePreloader.xml
View file

@ -31,7 +31,7 @@
</description>
</method>
<method name="get_resource_list" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns the list of resources inside the preloader.

2
doc/classes/ResourceSaver.xml
View file

@ -11,7 +11,7 @@
</tutorials>
<methods>
<method name="get_recognized_extensions">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="type" type="Resource">
</argument>

2
doc/classes/RichTextLabel.xml
View file

@ -113,7 +113,7 @@
<method name="parse_expressions_for_values">
<return type="Dictionary">
</return>
<argument index="0" name="expressions" type="PoolStringArray">
<argument index="0" name="expressions" type="PackedStringArray">
</argument>
<description>
Parses BBCode parameter [code]expressions[/code] into a dictionary.

2
doc/classes/SceneState.xml
View file

@ -81,7 +81,7 @@
</description>
</method>
<method name="get_node_groups" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="idx" type="int">
</argument>

4
doc/classes/SceneTree.xml
View file

@ -83,7 +83,7 @@
</description>
</method>
<method name="get_network_connected_peers" qualifiers="const">
<return type="PoolIntArray">
<return type="PackedIntArray">
</return>
<description>
Returns the peer IDs of all connected peers of this [SceneTree]'s [member network_peer].
@ -320,7 +320,7 @@
</description>
</signal>
<signal name="files_dropped">
<argument index="0" name="files" type="PoolStringArray">
<argument index="0" name="files" type="PackedStringArray">
</argument>
<argument index="1" name="screen" type="int">
</argument>

2
doc/classes/SpriteFrames.xml
View file

@ -57,7 +57,7 @@
</description>
</method>
<method name="get_animation_names" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns an array containing the names associated to each animation. Values are placed in alphabetical order.

4
doc/classes/StreamPeer.xml
View file

@ -171,7 +171,7 @@
<method name="put_data">
<return type="int" enum="Error">
</return>
<argument index="0" name="data" type="PoolByteArray">
<argument index="0" name="data" type="PackedByteArray">
</argument>
<description>
Sends a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an [enum @GlobalScope.Error] code.
@ -198,7 +198,7 @@
<method name="put_partial_data">
<return type="Array">
</return>
<argument index="0" name="data" type="PoolByteArray">
<argument index="0" name="data" type="PackedByteArray">
</argument>
<description>
Sends a chunk of data through the connection. If all the data could not be sent at once, only part of it will. This function returns two values, an [enum @GlobalScope.Error] code and an integer, describing how much data was actually sent.

2
doc/classes/StreamPeerBuffer.xml
View file

@ -49,7 +49,7 @@
</method>
</methods>
<members>
<member name="data_array" type="PoolByteArray" setter="set_data_array" getter="get_data_array" default="PoolByteArray( )">
<member name="data_array" type="PackedByteArray" setter="set_data_array" getter="get_data_array" default="PackedByteArray( )">
</member>
</members>
<constants>

50
doc/classes/String.xml
View file

@ -166,64 +166,64 @@
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PoolByteArray">
<argument index="0" name="from" type="PackedByteArray">
</argument>
<description>
Constructs a new String from the given [PoolByteArray].
Constructs a new String from the given [PackedByteArray].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PoolIntArray">
<argument index="0" name="from" type="PackedIntArray">
</argument>
<description>
Constructs a new String from the given [PoolIntArray].
Constructs a new String from the given [PackedIntArray].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PoolRealArray">
<argument index="0" name="from" type="PackedRealArray">
</argument>
<description>
Constructs a new String from the given [PoolRealArray].
Constructs a new String from the given [PackedRealArray].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PoolStringArray">
<argument index="0" name="from" type="PackedStringArray">
</argument>
<description>
Constructs a new String from the given [PoolStringArray].
Constructs a new String from the given [PackedStringArray].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PoolVector2Array">
<argument index="0" name="from" type="PackedVector2Array">
</argument>
<description>
Constructs a new String from the given [PoolVector2Array].
Constructs a new String from the given [PackedVector2Array].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PoolVector3Array">
<argument index="0" name="from" type="PackedVector3Array">
</argument>
<description>
Constructs a new String from the given [PoolVector3Array].
Constructs a new String from the given [PackedVector3Array].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="PoolColorArray">
<argument index="0" name="from" type="PackedColorArray">
</argument>
<description>
Constructs a new String from the given [PoolColorArray].
Constructs a new String from the given [PackedColorArray].
</description>
</method>
<method name="begins_with">
@ -236,7 +236,7 @@
</description>
</method>
<method name="bigrams">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns the bigrams (pairs of consecutive letters) of this string.
@ -597,7 +597,7 @@
</description>
</method>
<method name="md5_buffer">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<description>
Returns the MD5 hash of the string as an array of bytes.
@ -732,7 +732,7 @@
</description>
</method>
<method name="rsplit">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="delimiter" type="String">
</argument>
@ -764,7 +764,7 @@
</description>
</method>
<method name="sha1_buffer">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<description>
Returns the SHA-1 hash of the string as an array of bytes.
@ -778,7 +778,7 @@
</description>
</method>
<method name="sha256_buffer">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<description>
Returns the SHA-256 hash of the string as an array of bytes.
@ -801,7 +801,7 @@
</description>
</method>
<method name="split">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="delimiter" type="String">
</argument>
@ -823,7 +823,7 @@
</description>
</method>
<method name="split_floats">
<return type="PoolRealArray">
<return type="PackedRealArray">
</return>
<argument index="0" name="delimiter" type="String">
</argument>
@ -864,10 +864,10 @@
</description>
</method>
<method name="to_ascii">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<description>
Converts the String (which is a character array) to [PoolByteArray] (which is an array of bytes). The conversion is faster compared to [method to_utf8], as this method assumes that all the characters in the String are ASCII characters.
Converts the String (which is a character array) to [PackedByteArray] (which is an array of bytes). The conversion is faster compared to [method to_utf8], as this method assumes that all the characters in the String are ASCII characters.
</description>
</method>
<method name="to_float">
@ -899,10 +899,10 @@
</description>
</method>
<method name="to_utf8">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<description>
Converts the String (which is an array of characters) to [PoolByteArray] (which is an array of bytes). The conversion is a bit slower than [method to_ascii], but supports all UTF-8 characters. Therefore, you should prefer this function over [method to_ascii].
Converts the String (which is an array of characters) to [PackedByteArray] (which is an array of bytes). The conversion is a bit slower than [method to_ascii], but supports all UTF-8 characters. Therefore, you should prefer this function over [method to_ascii].
</description>
</method>
<method name="trim_prefix">

14
doc/classes/SurfaceTool.xml
View file

@ -22,7 +22,7 @@
<method name="add_bones">
<return type="void">
</return>
<argument index="0" name="bones" type="PoolIntArray">
<argument index="0" name="bones" type="PackedIntArray">
</argument>
<description>
Adds an array of bones for the next vertex to use. [code]bones[/code] must contain 4 integers.
@ -76,15 +76,15 @@
<method name="add_triangle_fan">
<return type="void">
</return>
<argument index="0" name="vertices" type="PoolVector3Array">
<argument index="0" name="vertices" type="PackedVector3Array">
</argument>
<argument index="1" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )">
<argument index="1" name="uvs" type="PackedVector2Array" default="PackedVector2Array( )">
</argument>
<argument index="2" name="colors" type="PoolColorArray" default="PoolColorArray( )">
<argument index="2" name="colors" type="PackedColorArray" default="PackedColorArray( )">
</argument>
<argument index="3" name="uv2s" type="PoolVector2Array" default="PoolVector2Array( )">
<argument index="3" name="uv2s" type="PackedVector2Array" default="PackedVector2Array( )">
</argument>
<argument index="4" name="normals" type="PoolVector3Array" default="PoolVector3Array( )">
<argument index="4" name="normals" type="PackedVector3Array" default="PackedVector3Array( )">
</argument>
<argument index="5" name="tangents" type="Array" default="[ ]">
</argument>
@ -123,7 +123,7 @@
<method name="add_weights">
<return type="void">
</return>
<argument index="0" name="weights" type="PoolRealArray">
<argument index="0" name="weights" type="PackedRealArray">
</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="PoolIntArray">
<return type="PackedIntArray">
</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]PoolIntArray[/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]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:
[codeblock]
var result = search(key, flags, line, column)
if result.size() &gt; 0:

28
doc/classes/Theme.xml
View file

@ -101,12 +101,12 @@
</description>
</method>
<method name="get_color_list" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the [Color]s as a [PoolStringArray] filled with each [Color]'s name, for use in [method get_color], if the theme has [code]type[/code].
Returns all the [Color]s as a [PackedStringArray] filled with each [Color]'s name, for use in [method get_color], if the theme has [code]type[/code].
</description>
</method>
<method name="get_constant" qualifiers="const">
@ -121,12 +121,12 @@
</description>
</method>
<method name="get_constant_list" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the constants as a [PoolStringArray] filled with each constant's name, for use in [method get_constant], if the theme has [code]type[/code].
Returns all the constants as a [PackedStringArray] filled with each constant's name, for use in [method get_constant], if the theme has [code]type[/code].
</description>
</method>
<method name="get_font" qualifiers="const">
@ -141,12 +141,12 @@
</description>
</method>
<method name="get_font_list" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the [Font]s as a [PoolStringArray] filled with each [Font]'s name, for use in [method get_font], if the theme has [code]type[/code].
Returns all the [Font]s as a [PackedStringArray] filled with each [Font]'s name, for use in [method get_font], if the theme has [code]type[/code].
</description>
</method>
<method name="get_icon" qualifiers="const">
@ -161,12 +161,12 @@
</description>
</method>
<method name="get_icon_list" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the icons as a [PoolStringArray] filled with each [Texture2D]'s name, for use in [method get_icon], if the theme has [code]type[/code].
Returns all the icons as a [PackedStringArray] filled with each [Texture2D]'s name, for use in [method get_icon], if the theme has [code]type[/code].
</description>
</method>
<method name="get_stylebox" qualifiers="const">
@ -181,28 +181,28 @@
</description>
</method>
<method name="get_stylebox_list" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the [StyleBox]s as a [PoolStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if the theme has [code]type[/code].
Returns all the [StyleBox]s as a [PackedStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if the theme has [code]type[/code].
</description>
</method>
<method name="get_stylebox_types" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns all the [StyleBox] types as a [PoolStringArray] filled with each [StyleBox]'s type, for use in [method get_stylebox] and/or [method get_stylebox_list], if the theme has [code]type[/code].
Returns all the [StyleBox] types as a [PackedStringArray] filled with each [StyleBox]'s type, for use in [method get_stylebox] and/or [method get_stylebox_list], if the theme has [code]type[/code].
</description>
</method>
<method name="get_type_list" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the types in [code]type[/code] as a [PoolStringArray] for use in any of the [code]get_*[/code] functions, if the theme has [code]type[/code].
Returns all the types in [code]type[/code] as a [PackedStringArray] for use in any of the [code]get_*[/code] functions, if the theme has [code]type[/code].
</description>
</method>
<method name="has_color" qualifiers="const">

4
doc/classes/Transform.xml
View file

@ -154,7 +154,7 @@
<argument index="0" name="v" type="Variant">
</argument>
<description>
Transforms the given [Vector3], [Plane], [AABB], or [PoolVector3Array] by this transform.
Transforms the given [Vector3], [Plane], [AABB], or [PackedVector3Array] by this transform.
</description>
</method>
<method name="xform_inv">
@ -163,7 +163,7 @@
<argument index="0" name="v" type="Variant">
</argument>
<description>
Inverse-transforms the given [Vector3], [Plane], [AABB], or [PoolVector3Array] by this transform.
Inverse-transforms the given [Vector3], [Plane], [AABB], or [PackedVector3Array] by this transform.
</description>
</method>
</methods>

4
doc/classes/Transform2D.xml
View file

@ -156,7 +156,7 @@
<argument index="0" name="v" type="Variant">
</argument>
<description>
Transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform.
Transforms the given [Vector2], [Rect2], or [PackedVector2Array] by this transform.
</description>
</method>
<method name="xform_inv">
@ -165,7 +165,7 @@
<argument index="0" name="v" type="Variant">
</argument>
<description>
Inverse-transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform.
Inverse-transforms the given [Vector2], [Rect2], or [PackedVector2Array] by this transform.
</description>
</method>
</methods>

2
doc/classes/Translation.xml
View file

@ -48,7 +48,7 @@
</description>
</method>
<method name="get_message_list" qualifiers="const">
<return type="PoolStringArray">
<return type="PackedStringArray">
</return>
<description>
Returns all the messages (keys).

14
doc/classes/VisualServer.xml
View file

@ -540,7 +540,7 @@
</return>
<argument index="0" name="occluder_polygon" type="RID">
</argument>
<argument index="1" name="shape" type="PoolVector2Array">
<argument index="1" name="shape" type="PackedVector2Array">
</argument>
<argument index="2" name="closed" type="bool">
</argument>
@ -553,7 +553,7 @@
</return>
<argument index="0" name="occluder_polygon" type="RID">
</argument>
<argument index="1" name="shape" type="PoolVector2Array">
<argument index="1" name="shape" type="PackedVector2Array">
</argument>
<description>
Sets the shape of the occluder polygon as lines.
@ -1564,7 +1564,7 @@
</description>
</method>
<method name="lightmap_capture_get_octree" qualifiers="const">
<return type="PoolByteArray">
<return type="PackedByteArray">
</return>
<argument index="0" name="capture" type="RID">
</argument>
@ -1617,7 +1617,7 @@
</return>
<argument index="0" name="capture" type="RID">
</argument>
<argument index="1" name="octree" type="PoolByteArray">
<argument index="1" name="octree" type="PackedByteArray">
</argument>
<description>
Sets the octree to be used by this lightmap capture.
@ -1902,7 +1902,7 @@
</argument>
<argument index="2" name="offset" type="int">
</argument>
<argument index="3" name="data" type="PoolByteArray">
<argument index="3" name="data" type="PackedByteArray">
</argument>
<description>
Updates a specific region of a vertex buffer for the specified surface. Warning: this function alters the vertex buffer directly with no safety mechanisms, you can easily corrupt your mesh.
@ -1943,7 +1943,7 @@
</description>
</method>
<method name="multimesh_get_buffer" qualifiers="const">
<return type="PoolRealArray">
<return type="PackedRealArray">
</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="PoolRealArray">
<argument index="1" name="buffer" type="PackedRealArray">
</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="PoolIntArray">
<return type="PackedIntArray">
</return>
<argument index="0" name="type" type="int" enum="VisualShader.Type">
</argument>

2
doc/classes/XMLParser.xml
View file

@ -115,7 +115,7 @@
<method name="open_buffer">
<return type="int" enum="Error">
</return>
<argument index="0" name="buffer" type="PoolByteArray">
<argument index="0" name="buffer" type="PackedByteArray">
</argument>
<description>
Opens an XML raw buffer for parsing. This returns an error code.

Some files were not shown because too many files have changed in this diff Show more