From 213a85521dcac9c01e1e4746733e606b610c0db4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Tue, 18 Feb 2020 13:59:24 +0100 Subject: doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes. --- doc/classes/@GlobalScope.xml | 17 ++- doc/classes/AStar.xml | 6 +- doc/classes/AStar2D.xml | 6 +- doc/classes/Animation.xml | 4 +- doc/classes/AnimationNodeStateMachinePlayback.xml | 2 +- doc/classes/AnimationPlayer.xml | 4 +- doc/classes/Array.xml | 28 ++-- doc/classes/ArrayMesh.xml | 22 +-- doc/classes/AudioStreamGeneratorPlayback.xml | 2 +- doc/classes/AudioStreamSample.xml | 2 +- doc/classes/CPUParticles.xml | 6 +- doc/classes/CPUParticles2D.xml | 6 +- doc/classes/CanvasItem.xml | 56 ++++---- doc/classes/ClassDB.xml | 6 +- doc/classes/CollisionPolygon.xml | 2 +- doc/classes/CollisionPolygon2D.xml | 4 +- doc/classes/ColorPicker.xml | 2 +- doc/classes/ConcavePolygonShape.xml | 4 +- doc/classes/ConcavePolygonShape2D.xml | 2 +- doc/classes/ConfigFile.xml | 8 +- doc/classes/ConvexPolygonShape.xml | 2 +- doc/classes/ConvexPolygonShape2D.xml | 4 +- doc/classes/Crypto.xml | 4 +- doc/classes/Curve2D.xml | 6 +- doc/classes/Curve3D.xml | 14 +- doc/classes/EditorExportPlugin.xml | 8 +- doc/classes/EditorFileDialog.xml | 2 +- doc/classes/EditorFileSystem.xml | 4 +- doc/classes/EditorInspectorPlugin.xml | 2 +- doc/classes/EditorPlugin.xml | 2 +- doc/classes/EditorProperty.xml | 2 +- doc/classes/EditorSettings.xml | 8 +- doc/classes/EditorSpatialGizmo.xml | 6 +- doc/classes/Expression.xml | 2 +- doc/classes/File.xml | 14 +- doc/classes/FileDialog.xml | 6 +- doc/classes/GIProbeData.xml | 14 +- doc/classes/Geometry.xml | 74 +++++------ doc/classes/Gradient.xml | 8 +- doc/classes/HTTPClient.xml | 10 +- doc/classes/HTTPRequest.xml | 6 +- doc/classes/HashingContext.xml | 4 +- doc/classes/HeightMapShape.xml | 2 +- doc/classes/Image.xml | 44 ++---- doc/classes/ItemList.xml | 2 +- doc/classes/Line2D.xml | 2 +- doc/classes/MainLoop.xml | 2 +- doc/classes/Marshalls.xml | 8 +- doc/classes/Mesh.xml | 2 +- doc/classes/MeshDataTool.xml | 14 +- doc/classes/MeshLibrary.xml | 2 +- doc/classes/MonoGCHandle.xml | 13 ++ doc/classes/MultiMesh.xml | 10 +- doc/classes/MultiplayerAPI.xml | 6 +- doc/classes/Navigation.xml | 2 +- doc/classes/Navigation2D.xml | 2 +- doc/classes/Navigation2DServer.xml | 2 +- doc/classes/NavigationAgent.xml | 4 +- doc/classes/NavigationAgent2D.xml | 4 +- doc/classes/NavigationMesh.xml | 8 +- doc/classes/NavigationPolygon.xml | 32 ++--- doc/classes/NavigationServer.xml | 2 +- doc/classes/OS.xml | 17 +-- doc/classes/Object.xml | 8 +- doc/classes/OccluderPolygon2D.xml | 2 +- doc/classes/PackedByteArray.xml | 155 ++++++++++++++++++++++ doc/classes/PackedColorArray.xml | 99 ++++++++++++++ doc/classes/PackedDataContainer.xml | 2 +- doc/classes/PackedIntArray.xml | 100 ++++++++++++++ doc/classes/PackedRealArray.xml | 99 ++++++++++++++ doc/classes/PackedScene.xml | 2 +- doc/classes/PackedStringArray.xml | 99 ++++++++++++++ doc/classes/PackedVector2Array.xml | 99 ++++++++++++++ doc/classes/PackedVector3Array.xml | 99 ++++++++++++++ doc/classes/PacketPeer.xml | 4 +- doc/classes/Performance.xml | 54 ++++---- doc/classes/Polygon2D.xml | 14 +- doc/classes/PolygonPathFinder.xml | 8 +- doc/classes/PoolByteArray.xml | 155 ---------------------- doc/classes/PoolColorArray.xml | 99 -------------- doc/classes/PoolIntArray.xml | 100 -------------- doc/classes/PoolRealArray.xml | 99 -------------- doc/classes/PoolStringArray.xml | 108 --------------- doc/classes/PoolVector2Array.xml | 99 -------------- doc/classes/PoolVector3Array.xml | 99 -------------- doc/classes/ProjectSettings.xml | 14 +- doc/classes/ResourceFormatLoader.xml | 2 +- doc/classes/ResourceFormatSaver.xml | 2 +- doc/classes/ResourceLoader.xml | 4 +- doc/classes/ResourcePreloader.xml | 2 +- doc/classes/ResourceSaver.xml | 2 +- doc/classes/RichTextLabel.xml | 2 +- doc/classes/SceneState.xml | 2 +- doc/classes/SceneTree.xml | 4 +- doc/classes/SpriteFrames.xml | 2 +- doc/classes/StreamPeer.xml | 4 +- doc/classes/StreamPeerBuffer.xml | 2 +- doc/classes/String.xml | 50 +++---- doc/classes/SurfaceTool.xml | 14 +- doc/classes/TextEdit.xml | 4 +- doc/classes/Theme.xml | 28 ++-- doc/classes/Transform.xml | 4 +- doc/classes/Transform2D.xml | 4 +- doc/classes/Translation.xml | 2 +- doc/classes/VisualServer.xml | 14 +- doc/classes/VisualShader.xml | 2 +- doc/classes/XMLParser.xml | 2 +- 107 files changed, 1163 insertions(+), 1177 deletions(-) create mode 100644 doc/classes/MonoGCHandle.xml create mode 100644 doc/classes/PackedByteArray.xml create mode 100644 doc/classes/PackedColorArray.xml create mode 100644 doc/classes/PackedIntArray.xml create mode 100644 doc/classes/PackedRealArray.xml create mode 100644 doc/classes/PackedStringArray.xml create mode 100644 doc/classes/PackedVector2Array.xml create mode 100644 doc/classes/PackedVector3Array.xml delete mode 100644 doc/classes/PoolByteArray.xml delete mode 100644 doc/classes/PoolColorArray.xml delete mode 100644 doc/classes/PoolIntArray.xml delete mode 100644 doc/classes/PoolRealArray.xml delete mode 100644 doc/classes/PoolStringArray.xml delete mode 100644 doc/classes/PoolVector2Array.xml delete mode 100644 doc/classes/PoolVector3Array.xml (limited to 'doc') diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 439937e4f5..5899829e95 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -30,6 +30,9 @@ The [Geometry] singleton. + + The [GodotSharp] singleton. Only available when using Godot's Mono build. + The [IP] singleton. @@ -1520,25 +1523,25 @@ Variable is of type [Array]. - Variable is of type [PoolByteArray]. + Variable is of type [PackedByteArray]. - Variable is of type [PoolIntArray]. + Variable is of type [PackedIntArray]. - Variable is of type [PoolRealArray]. + Variable is of type [PackedRealArray]. - Variable is of type [PoolStringArray]. + Variable is of type [PackedStringArray]. - Variable is of type [PoolVector2Array]. + Variable is of type [PackedVector2Array]. - Variable is of type [PoolVector3Array]. + Variable is of type [PackedVector3Array]. - Variable is of type [PoolColorArray]. + Variable is of type [PackedColorArray]. Represents the size of the [enum Variant.Type] enum. diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index ccbb033444..d175aa6f45 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -152,7 +152,7 @@ - + @@ -185,7 +185,7 @@ - + @@ -213,7 +213,7 @@ - + diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml index d620ef2a79..af1fb3e273 100644 --- a/doc/classes/AStar2D.xml +++ b/doc/classes/AStar2D.xml @@ -111,7 +111,7 @@ - + @@ -144,7 +144,7 @@ - + @@ -172,7 +172,7 @@ - + diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index f77dfdc9a1..46b0b952b6 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -274,7 +274,7 @@ - + @@ -627,7 +627,7 @@ - + diff --git a/doc/classes/AnimationNodeStateMachinePlayback.xml b/doc/classes/AnimationNodeStateMachinePlayback.xml index 0198237bed..b75ff04329 100644 --- a/doc/classes/AnimationNodeStateMachinePlayback.xml +++ b/doc/classes/AnimationNodeStateMachinePlayback.xml @@ -23,7 +23,7 @@ - + Returns the current travel path as computed internally by the A* algorithm. diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 3e8315f686..cedfca4c31 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -86,7 +86,7 @@ - + Returns the list of stored animation names. @@ -111,7 +111,7 @@ - + Returns a list of the animation names that are currently queued to play. diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 08455bb7bc..6c3e9e8fed 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -22,64 +22,64 @@ - + - Constructs an array from a [PoolColorArray]. + Constructs an array from a [PackedColorArray]. - + - Constructs an array from a [PoolVector3Array]. + Constructs an array from a [PackedVector3Array]. - + - Constructs an array from a [PoolVector2Array]. + Constructs an array from a [PackedVector2Array]. - + - Constructs an array from a [PoolStringArray]. + Constructs an array from a [PackedStringArray]. - + - Constructs an array from a [PoolRealArray]. + Constructs an array from a [PackedRealArray]. - + - Constructs an array from a [PoolIntArray]. + Constructs an array from a [PackedIntArray]. - + - Constructs an array from a [PoolByteArray]. + Constructs an array from a [PackedByteArray]. diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 2dbf55e522..857897dab4 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -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 @@ - + Updates a specified region of mesh arrays on the GPU. @@ -202,31 +202,31 @@ Amount of weights/bone indices per vertex (always 4). - [PoolVector3Array], [PoolVector2Array], or [Array] of vertex positions. + [PackedVector3Array], [PackedVector2Array], or [Array] of vertex positions. - [PoolVector3Array] of vertex normals. + [PackedVector3Array] of vertex normals. - [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. - [PoolColorArray] of vertex colors. + [PackedColorArray] of vertex colors. - [PoolVector2Array] for UV coordinates. + [PackedVector2Array] for UV coordinates. - [PoolVector2Array] for second UV coordinates. + [PackedVector2Array] for second UV coordinates. - [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. - [PoolRealArray] of bone weights. Each element in groups of 4 floats. + [PackedRealArray] of bone weights. Each element in groups of 4 floats. - [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. diff --git a/doc/classes/AudioStreamGeneratorPlayback.xml b/doc/classes/AudioStreamGeneratorPlayback.xml index 2552cd50a4..e3e17b8a93 100644 --- a/doc/classes/AudioStreamGeneratorPlayback.xml +++ b/doc/classes/AudioStreamGeneratorPlayback.xml @@ -37,7 +37,7 @@ - + diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 898879ae27..6d99433c90 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -22,7 +22,7 @@ - + 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. diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index b9cc655784..6a6525e99a 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -171,13 +171,13 @@ The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_BOX]. - + Sets the [Color]s to modulate particles by when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS]. - + Sets the direction the particles will be emitted in when using [constant EMISSION_SHAPE_DIRECTED_POINTS]. - + Sets the initial positions to spawn particles when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS]. diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 926b8e461c..799ba32075 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -169,13 +169,13 @@ Particle draw order. Uses [enum DrawOrder] values. - + Sets the [Color]s to modulate particles by when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS]. - + Sets the direction the particles will be emitted in when using [constant EMISSION_SHAPE_DIRECTED_POINTS]. - + Sets the initial positions to spawn particles when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS]. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 7f50587e66..aed02e27e7 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -76,11 +76,11 @@ - + - + @@ -88,7 +88,7 @@ - + @@ -118,17 +118,17 @@ - + - + - + - + - + @@ -141,7 +141,7 @@ - + @@ -154,9 +154,9 @@ - + - + @@ -169,13 +169,13 @@ - + - + @@ -188,11 +188,11 @@ - + - + - + @@ -200,7 +200,7 @@ - + @@ -213,7 +213,7 @@ - + @@ -226,9 +226,9 @@ - + - + @@ -239,11 +239,11 @@ - + - + - + @@ -253,7 +253,7 @@ - + @@ -342,7 +342,7 @@ - + @@ -369,7 +369,7 @@ - + @@ -396,9 +396,9 @@ - + - + diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index 4d7ccb65e8..a0f13494af 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -48,7 +48,7 @@ - + @@ -162,14 +162,14 @@ - + Returns the names of all the classes available. - + diff --git a/doc/classes/CollisionPolygon.xml b/doc/classes/CollisionPolygon.xml index ac519d3817..8aceec17a8 100644 --- a/doc/classes/CollisionPolygon.xml +++ b/doc/classes/CollisionPolygon.xml @@ -17,7 +17,7 @@ If [code]true[/code], no collision will be produced. - + 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. diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml index c4fd417918..e3135a4d0f 100644 --- a/doc/classes/CollisionPolygon2D.xml +++ b/doc/classes/CollisionPolygon2D.xml @@ -22,8 +22,8 @@ - - 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. + + 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. diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index d0c8e3f948..0805a87d18 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -29,7 +29,7 @@ - + Returns the list of colors in the presets of the color picker. diff --git a/doc/classes/ConcavePolygonShape.xml b/doc/classes/ConcavePolygonShape.xml index 3ae07ee52f..21f2f681b9 100644 --- a/doc/classes/ConcavePolygonShape.xml +++ b/doc/classes/ConcavePolygonShape.xml @@ -10,7 +10,7 @@ - + Returns the faces (an array of triangles). @@ -19,7 +19,7 @@ - + Sets the faces (an array of triangles). diff --git a/doc/classes/ConcavePolygonShape2D.xml b/doc/classes/ConcavePolygonShape2D.xml index 6fb32436a8..9999d086da 100644 --- a/doc/classes/ConcavePolygonShape2D.xml +++ b/doc/classes/ConcavePolygonShape2D.xml @@ -12,7 +12,7 @@ - + The array of points that make up the [ConcavePolygonShape2D]'s line segments. diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index ad36f1f1c3..00d98130f3 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -51,7 +51,7 @@ - + @@ -60,7 +60,7 @@ - + Returns an array of all defined section identifiers. @@ -114,7 +114,7 @@ - + @@ -154,7 +154,7 @@ - + diff --git a/doc/classes/ConvexPolygonShape.xml b/doc/classes/ConvexPolygonShape.xml index 544f304051..077bb57a03 100644 --- a/doc/classes/ConvexPolygonShape.xml +++ b/doc/classes/ConvexPolygonShape.xml @@ -11,7 +11,7 @@ - + The list of 3D points forming the convex polygon shape. diff --git a/doc/classes/ConvexPolygonShape2D.xml b/doc/classes/ConvexPolygonShape2D.xml index e17048e061..cba446fff8 100644 --- a/doc/classes/ConvexPolygonShape2D.xml +++ b/doc/classes/ConvexPolygonShape2D.xml @@ -13,7 +13,7 @@ - + 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 @@ - + The polygon's list of vertices. Can be in either clockwise or counterclockwise order. diff --git a/doc/classes/Crypto.xml b/doc/classes/Crypto.xml index fb373145f9..10f1f18f0d 100644 --- a/doc/classes/Crypto.xml +++ b/doc/classes/Crypto.xml @@ -28,12 +28,12 @@ - + - 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]. diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index f6eacfb33b..8ac6258e97 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -41,10 +41,10 @@ - + - Returns the cache of points as a [PoolVector2Array]. + Returns the cache of points as a [PackedVector2Array]. @@ -178,7 +178,7 @@ - + diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index 52b0052908..c5345c8025 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -41,24 +41,24 @@ - + - Returns the cache of points as a [PoolVector3Array]. + Returns the cache of points as a [PackedVector3Array]. - + - Returns the cache of tilts as a [PoolRealArray]. + Returns the cache of tilts as a [PackedRealArray]. - + - 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. @@ -227,7 +227,7 @@ - + diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index 5de68cae71..da3840384e 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -10,7 +10,7 @@ - + @@ -34,7 +34,7 @@ - + @@ -44,7 +44,7 @@ - + @@ -96,7 +96,7 @@ - + diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index 91adf6f2af..2afdfde064 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -84,7 +84,7 @@ - + Emitted when multiple files are selected. diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index a05fbf2be7..a79c57e90f 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -85,14 +85,14 @@ - + Remitted if a resource is reimported. - + diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml index eaddd9917c..3cc624f49b 100644 --- a/doc/classes/EditorInspectorPlugin.xml +++ b/doc/classes/EditorInspectorPlugin.xml @@ -40,7 +40,7 @@ - + diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index e441562051..d17fd0a661 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -253,7 +253,7 @@ - + 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]. diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index b93274491a..338ebcd770 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -93,7 +93,7 @@ - + diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 30fc1e0c7b..ace5f0f11b 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -50,7 +50,7 @@ - + Gets the list of favorite files and directories for this project. @@ -76,7 +76,7 @@ - + Gets the list of recently visited folders in the file dialog for this project. @@ -126,7 +126,7 @@ - + Sets the list of favorite files and directories for this project. @@ -159,7 +159,7 @@ - + Sets the list of recently visited folders in the file dialog for this project. diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index e7c5ca9c0f..b8c4daab07 100644 --- a/doc/classes/EditorSpatialGizmo.xml +++ b/doc/classes/EditorSpatialGizmo.xml @@ -12,7 +12,7 @@ - + @@ -29,7 +29,7 @@ - + @@ -45,7 +45,7 @@ - + diff --git a/doc/classes/Expression.xml b/doc/classes/Expression.xml index b0a2802e43..fcd1aa43c0 100644 --- a/doc/classes/Expression.xml +++ b/doc/classes/Expression.xml @@ -59,7 +59,7 @@ - + Parses the expression and returns an [enum Error] code. diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 7fa87c2b60..e9477517cf 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -87,16 +87,16 @@ - + - Returns next [code]len[/code] bytes of the file as a [PoolByteArray]. + Returns next [code]len[/code] bytes of the file as a [PackedByteArray]. - + @@ -252,7 +252,7 @@ - + Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. @@ -329,7 +329,7 @@ - + Stores the given array of bytes in the file. @@ -338,12 +338,12 @@ - + - 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. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 37b5cec2c9..f2c65a8610 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -68,8 +68,8 @@ The currently selected file path of the file dialog. - - 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]. + + 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]. The dialog's open or save mode, which affects the selection behavior. See enum [code]Mode[/code] constants. @@ -98,7 +98,7 @@ - + Emitted when the user selects multiple files. diff --git a/doc/classes/GIProbeData.xml b/doc/classes/GIProbeData.xml index d2918c24f7..3504d127b8 100644 --- a/doc/classes/GIProbeData.xml +++ b/doc/classes/GIProbeData.xml @@ -16,13 +16,13 @@ - + - + - + - + @@ -34,19 +34,19 @@ - + - + - + diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml index 739c860b28..9d4e0d0388 100644 --- a/doc/classes/Geometry.xml +++ b/doc/classes/Geometry.xml @@ -51,9 +51,9 @@ - + - + @@ -64,9 +64,9 @@ - + - + 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 @@ - + - + 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. - + - + 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 @@ - + - + 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 @@ - + @@ -169,11 +169,11 @@ - 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]). - + @@ -184,7 +184,7 @@ - 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]). @@ -199,9 +199,9 @@ - + - + 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 @@ - + - + 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 @@ - + 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 @@ - + Returns [code]true[/code] if [code]polygon[/code]'s vertices are ordered in clockwise order, otherwise returns [code]false[/code]. @@ -271,7 +271,7 @@ - + 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 @@ - + - + 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 @@ - + @@ -307,7 +307,7 @@ - + @@ -370,7 +370,7 @@ - + @@ -379,11 +379,11 @@ - 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. - + @@ -394,7 +394,7 @@ - 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. @@ -413,7 +413,7 @@ - + @@ -424,7 +424,7 @@ - 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. @@ -445,21 +445,21 @@ - + - + - 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. - + - + - 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. diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml index 3ce70045ef..12c87f9cff 100644 --- a/doc/classes/Gradient.xml +++ b/doc/classes/Gradient.xml @@ -87,11 +87,11 @@ - - Gradient's colors returned as a [PoolColorArray]. + + Gradient's colors returned as a [PackedColorArray]. - - Gradient's offsets returned as a [PoolRealArray]. + + Gradient's offsets returned as a [PackedRealArray]. diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index bdcbb11ef0..76153ae041 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -55,7 +55,7 @@ - + Returns the response headers. @@ -124,7 +124,7 @@ - + Reads one chunk from the response. @@ -137,7 +137,7 @@ - + @@ -160,9 +160,9 @@ - + - + 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]. diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 313f21d8f9..53ca1fc6a9 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -96,7 +96,7 @@ - + @@ -136,9 +136,9 @@ - + - + Emitted when a request is completed. diff --git a/doc/classes/HashingContext.xml b/doc/classes/HashingContext.xml index bc585df4a0..f8152c813e 100644 --- a/doc/classes/HashingContext.xml +++ b/doc/classes/HashingContext.xml @@ -33,7 +33,7 @@ - + Closes the current context, and return the computed hash. @@ -51,7 +51,7 @@ - + Updates the computation with the given [code]chunk[/code] of data. diff --git a/doc/classes/HeightMapShape.xml b/doc/classes/HeightMapShape.xml index f94089066c..505961cd0c 100644 --- a/doc/classes/HeightMapShape.xml +++ b/doc/classes/HeightMapShape.xml @@ -11,7 +11,7 @@ - + Height map data, pool array must be of [member map_width] * [member map_depth] size. diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index b4a46dd661..8bd2213194 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -150,7 +150,7 @@ - + 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 @@ - + Returns the image's raw data. @@ -273,7 +273,7 @@ - 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. @@ -282,7 +282,7 @@ - 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. @@ -355,7 +355,7 @@ - + Loads an image from the binary contents of a JPEG file. @@ -364,7 +364,7 @@ - + Loads an image from the binary contents of a PNG file. @@ -373,19 +373,12 @@ - + Loads an image from the binary contents of a WebP file. - - - - - 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. - - @@ -459,14 +452,11 @@ - 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] @@ -478,14 +468,11 @@ - 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] @@ -503,16 +490,9 @@ Converts the raw data from the sRGB colorspace to a linear scale. - - - - - Unlocks the data and prevents changes. - - - + Holds all of the image's color data in a given format. See [enum Format] constants. diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index 1bc36abf66..d53fabaacb 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -142,7 +142,7 @@ - + Returns an array with the indexes of the selected items. diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index bed5bbaea7..68cec3e624 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -84,7 +84,7 @@ The style for the points between the start and the end. - + The points that form the lines. The line is drawn between every point set in this array. diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml index 2ae7eacdb6..b12d4d9978 100644 --- a/doc/classes/MainLoop.xml +++ b/doc/classes/MainLoop.xml @@ -46,7 +46,7 @@ - + diff --git a/doc/classes/Marshalls.xml b/doc/classes/Marshalls.xml index f9ca391f1c..6707068c5a 100644 --- a/doc/classes/Marshalls.xml +++ b/doc/classes/Marshalls.xml @@ -10,12 +10,12 @@ - + - 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]. @@ -42,10 +42,10 @@ - + - Returns a Base64-encoded string of a given [PoolByteArray]. + Returns a Base64-encoded string of a given [PackedByteArray]. diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index f2602dfc7f..dc7ffc8934 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -49,7 +49,7 @@ - + Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. diff --git a/doc/classes/MeshDataTool.xml b/doc/classes/MeshDataTool.xml index 5c6401521a..bdc9d20305 100644 --- a/doc/classes/MeshDataTool.xml +++ b/doc/classes/MeshDataTool.xml @@ -57,7 +57,7 @@ - + @@ -160,7 +160,7 @@ - + @@ -185,7 +185,7 @@ - + @@ -194,7 +194,7 @@ - + @@ -248,7 +248,7 @@ - + @@ -303,7 +303,7 @@ - + Sets the bones of the given vertex. @@ -380,7 +380,7 @@ - + Sets the bone weights of the given vertex. diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml index 3a3dd08caf..ec12a0ff42 100644 --- a/doc/classes/MeshLibrary.xml +++ b/doc/classes/MeshLibrary.xml @@ -36,7 +36,7 @@ - + Returns the list of item IDs in use. diff --git a/doc/classes/MonoGCHandle.xml b/doc/classes/MonoGCHandle.xml new file mode 100644 index 0000000000..1e33dd1359 --- /dev/null +++ b/doc/classes/MonoGCHandle.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index 8a4a192ed4..6831fc88df 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -105,11 +105,11 @@ - + - + - + 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 @@ Mesh to be drawn. - + - + Format of transform used to transform mesh, either 2D or 3D. diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index b82214b246..968357ea07 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -19,7 +19,7 @@ - + Returns the peer IDs of all connected peers of this MultiplayerAPI's [member network_peer]. @@ -65,7 +65,7 @@ - + @@ -126,7 +126,7 @@ - + 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. diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml index be36be0429..d7da753c61 100644 --- a/doc/classes/Navigation.xml +++ b/doc/classes/Navigation.xml @@ -16,7 +16,7 @@ - + diff --git a/doc/classes/Navigation2D.xml b/doc/classes/Navigation2D.xml index 734469eaa9..9ef4a51ff0 100644 --- a/doc/classes/Navigation2D.xml +++ b/doc/classes/Navigation2D.xml @@ -16,7 +16,7 @@ - + diff --git a/doc/classes/Navigation2DServer.xml b/doc/classes/Navigation2DServer.xml index 3950e35697..67619d708d 100644 --- a/doc/classes/Navigation2DServer.xml +++ b/doc/classes/Navigation2DServer.xml @@ -174,7 +174,7 @@ - + diff --git a/doc/classes/NavigationAgent.xml b/doc/classes/NavigationAgent.xml index dc759bc72b..f896bf6d15 100644 --- a/doc/classes/NavigationAgent.xml +++ b/doc/classes/NavigationAgent.xml @@ -24,7 +24,7 @@ - + Returns the path from start to finish in global coordinates. @@ -34,7 +34,7 @@ - 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]. diff --git a/doc/classes/NavigationAgent2D.xml b/doc/classes/NavigationAgent2D.xml index 6f356e7e4c..116db76cc5 100644 --- a/doc/classes/NavigationAgent2D.xml +++ b/doc/classes/NavigationAgent2D.xml @@ -24,7 +24,7 @@ - + Returns the path from start to finish in global coordinates. @@ -34,7 +34,7 @@ - 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]. diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index fb3babf4aa..5b7a188e5a 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -10,7 +10,7 @@ - + @@ -38,7 +38,7 @@ - + @@ -52,7 +52,7 @@ - + @@ -70,7 +70,7 @@ - + diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 0157a6f3f7..908617fb91 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -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 @@ - + - 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. - + - 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. - + Adds a polygon using the indices of the vertices you get when calling [method get_vertices]. @@ -70,12 +70,12 @@ - + - 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. @@ -86,12 +86,12 @@ - + - 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. @@ -102,10 +102,10 @@ - + - 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. @@ -129,7 +129,7 @@ - + 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 @@ - + Sets the vertices that can be then indexed to create polygons with the [method add_polygon] method. diff --git a/doc/classes/NavigationServer.xml b/doc/classes/NavigationServer.xml index 7553d700f8..ad7c56f361 100644 --- a/doc/classes/NavigationServer.xml +++ b/doc/classes/NavigationServer.xml @@ -174,7 +174,7 @@ - + diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index d361ea83e6..6ce2d4bcbb 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -93,7 +93,7 @@ - + @@ -150,14 +150,14 @@ - + Returns the command line arguments passed to the engine. - + 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. - - - - - Returns the total amount of dynamic memory used (only works in debug). - - @@ -224,7 +217,7 @@ - + With this function you can get the list of dangerous permissions that have been granted to the Android application. @@ -734,7 +727,7 @@ - + Shows the number of resources loaded by the game of the given types. diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 858bf5b635..5388d93b8d 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -251,10 +251,10 @@ - + - Returns the object's metadata as a [PoolStringArray]. + Returns the object's metadata as a [PackedStringArray]. @@ -273,7 +273,7 @@ - + Returns the object's [Script] instance, or [code]null[/code] if none is assigned. @@ -456,7 +456,7 @@ - + Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality. diff --git a/doc/classes/OccluderPolygon2D.xml b/doc/classes/OccluderPolygon2D.xml index 6cfef42204..8a59ef5cb4 100644 --- a/doc/classes/OccluderPolygon2D.xml +++ b/doc/classes/OccluderPolygon2D.xml @@ -17,7 +17,7 @@ The culling mode to use. - + 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. diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml new file mode 100644 index 0000000000..e9b86e93dd --- /dev/null +++ b/doc/classes/PackedByteArray.xml @@ -0,0 +1,155 @@ + + + + A packed [Array] of bytes. + + + 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. + + + + + + + + + + + Constructs a new [PackedByteArray]. Optionally, you can pass in a generic [Array] that will be converted. + + + + + + + Appends an element at the end of the array (alias of [method push_back]). + + + + + + + Appends a [PackedByteArray] at the end of this array. + + + + + + + + + Returns a new [PackedByteArray] with the data compressed. 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. + + + + + + + Returns [code]true[/code] if the array is empty. + + + + + + + Returns a copy of the array's contents as [String]. Fast alternative to [method get_string_from_utf8] if the content is ASCII-only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use [method get_string_from_utf8]. + + + + + + + Returns a copy of the array's contents as [String]. Slower than [method get_string_from_ascii] but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. + + + + + + + Returns a hexadecimal representation of this array as a [String]. + [codeblock] + var array = PackedByteArray([11, 46, 255]) + print(array.hex_encode()) # Prints: 0b2eff + [/codeblock] + + + + + + + + + + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + + + + + Reverses the order of the elements in the array. + + + + + + + Appends an element at the end of the array. + + + + + + + Removes an element from the array by index. + + + + + + + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + + + + + + + + + Changes the byte at the given index. + + + + + + + Returns the size 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. + + + + + + diff --git a/doc/classes/PackedColorArray.xml b/doc/classes/PackedColorArray.xml new file mode 100644 index 0000000000..1d1614b081 --- /dev/null +++ b/doc/classes/PackedColorArray.xml @@ -0,0 +1,99 @@ + + + + A packed [Array] of [Color]s. + + + 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. + + + + + + + + + + + Constructs a new [PackedColorArray]. Optionally, you can pass in a generic [Array] that will be converted. + + + + + + + Appends an element at the end of the array (alias of [method push_back]). + + + + + + + Appends a [PackedColorArray] at the end of this array. + + + + + + + Returns [code]true[/code] if the array is empty. + + + + + + + + + + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + + + + + Reverses the order of the elements in the array. + + + + + + + Appends a value to the array. + + + + + + + Removes an element from the array by index. + + + + + + + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + + + + + + + + + Changes the [Color] at the given index. + + + + + + + Returns the size of the array. + + + + + + diff --git a/doc/classes/PackedDataContainer.xml b/doc/classes/PackedDataContainer.xml index 79c9fa8d9c..296f9d3373 100644 --- a/doc/classes/PackedDataContainer.xml +++ b/doc/classes/PackedDataContainer.xml @@ -23,7 +23,7 @@ - + diff --git a/doc/classes/PackedIntArray.xml b/doc/classes/PackedIntArray.xml new file mode 100644 index 0000000000..536b4d9aaf --- /dev/null +++ b/doc/classes/PackedIntArray.xml @@ -0,0 +1,100 @@ + + + + A packed [Array] of integers ([int]). + + + 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. + + + + + + + + + + + Constructs a new [PackedIntArray]. Optionally, you can pass in a generic [Array] that will be converted. + + + + + + + Appends an element at the end of the array (alias of [method push_back]). + + + + + + + Appends a [PackedIntArray] at the end of this array. + + + + + + + Returns [code]true[/code] if the array is empty. + + + + + + + + + + + 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]). + + + + + Reverses the order of the elements in the array. + + + + + + + Appends a value to the array. + + + + + + + Removes an element from the array by index. + + + + + + + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + + + + + + + + + Changes the integer at the given index. + + + + + + + Returns the array size. + + + + + + diff --git a/doc/classes/PackedRealArray.xml b/doc/classes/PackedRealArray.xml new file mode 100644 index 0000000000..7a7415b279 --- /dev/null +++ b/doc/classes/PackedRealArray.xml @@ -0,0 +1,99 @@ + + + + A packed [Array] of reals ([float]). + + + 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. + + + + + + + + + + + Constructs a new [PackedRealArray]. Optionally, you can pass in a generic [Array] that will be converted. + + + + + + + Appends an element at the end of the array (alias of [method push_back]). + + + + + + + Appends a [PackedRealArray] at the end of this array. + + + + + + + Returns [code]true[/code] if the array is empty. + + + + + + + + + + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + + + + + Reverses the order of the elements in the array. + + + + + + + Appends an element at the end of the array. + + + + + + + Removes an element from the array by index. + + + + + + + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + + + + + + + + + Changes the float at the given index. + + + + + + + Returns the size of the array. + + + + + + diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index d13195bd5e..8efe1e2b4b 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -65,7 +65,7 @@ - + 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. diff --git a/doc/classes/PackedStringArray.xml b/doc/classes/PackedStringArray.xml new file mode 100644 index 0000000000..8824f7f8a5 --- /dev/null +++ b/doc/classes/PackedStringArray.xml @@ -0,0 +1,99 @@ + + + + A packed [Array] of [String]s. + + + 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. + + + + + + + + + + + Constructs a new [PackedStringArray]. Optionally, you can pass in a generic [Array] that will be converted. + + + + + + + Appends an element at the end of the array (alias of [method push_back]). + + + + + + + Appends a [PackedStringArray] at the end of this array. + + + + + + + Returns [code]true[/code] if the array is empty. + + + + + + + + + + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + + + + + Reverses the order of the elements in the array. + + + + + + + Appends a string element at end of the array. + + + + + + + Removes an element from the array by index. + + + + + + + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + + + + + + + + + Changes the [String] at the given index. + + + + + + + Returns the size of the array. + + + + + + diff --git a/doc/classes/PackedVector2Array.xml b/doc/classes/PackedVector2Array.xml new file mode 100644 index 0000000000..339296180b --- /dev/null +++ b/doc/classes/PackedVector2Array.xml @@ -0,0 +1,99 @@ + + + + A packed [Array] of [Vector2]s. + + + 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. + + + + + + + + + + + Constructs a new [PackedVector2Array]. Optionally, you can pass in a generic [Array] that will be converted. + + + + + + + Appends an element at the end of the array (alias of [method push_back]). + + + + + + + Appends a [PackedVector2Array] at the end of this array. + + + + + + + Returns [code]true[/code] if the array is empty. + + + + + + + + + + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + + + + + Reverses the order of the elements in the array. + + + + + + + Inserts a [Vector2] at the end. + + + + + + + Removes an element from the array by index. + + + + + + + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + + + + + + + + + Changes the [Vector2] at the given index. + + + + + + + Returns the size of the array. + + + + + + diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml new file mode 100644 index 0000000000..2c5e2a63e3 --- /dev/null +++ b/doc/classes/PackedVector3Array.xml @@ -0,0 +1,99 @@ + + + + A packed [Array] of [Vector3]s. + + + 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. + + + + + + + + + + + Constructs a new [PackedVector3Array]. Optionally, you can pass in a generic [Array] that will be converted. + + + + + + + Appends an element at the end of the array (alias of [method push_back]). + + + + + + + Appends a [PackedVector3Array] at the end of this array. + + + + + + + Returns [code]true[/code] if the array is empty. + + + + + + + + + + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + + + + + Reverses the order of the elements in the array. + + + + + + + Inserts a [Vector3] at the end. + + + + + + + Removes an element from the array by index. + + + + + + + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + + + + + + + + + Changes the [Vector3] at the given index. + + + + + + + Returns the size of the array. + + + + + + diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index b721bc9df4..e3e2f63e14 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -17,7 +17,7 @@ - + Gets a raw packet. @@ -43,7 +43,7 @@ - + Sends a raw packet. diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml index a7bf947011..378b165644 100644 --- a/doc/classes/Performance.xml +++ b/doc/classes/Performance.xml @@ -37,82 +37,76 @@ Static memory currently used, in bytes. Not available in release builds. - - Dynamic memory currently used, in bytes. Not available in release builds. - - + Available static memory. Not available in release builds. - - Available dynamic memory. Not available in release builds. - - + Largest amount of memory the message queue buffer has used, in bytes. The message queue is used for deferred functions calls and notifications. - + Number of objects currently instanced (including nodes). - + Number of resources currently used. - + Number of nodes currently instanced in the scene tree. This also includes the root node. - + Number of orphan nodes, i.e. nodes which are not parented to a node of the scene tree. - + 3D objects drawn per frame. - + Vertices drawn per frame. 3D only. - + Material changes per frame. 3D only. - + Shader changes per frame. 3D only. - + Render surface changes per frame. 3D only. - + Draw calls per frame. 3D only. - + The amount of video memory used, i.e. texture and vertex memory combined. - + The amount of texture memory used. - + The amount of vertex memory used. - + Unimplemented in the GLES2 rendering backend, always returns 0. - + Number of active [RigidBody2D] nodes in the game. - + Number of collision pairs in the 2D physics engine. - + Number of islands in the 2D physics engine. - + Number of active [RigidBody] and [VehicleBody] nodes in the game. - + Number of collision pairs in the 3D physics engine. - + Number of islands in the 3D physics engine. - + Output latency of the [AudioServer]. - + Represents the size of the [enum Monitor] enum. diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index af4e8e1671..2a408e277a 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -14,7 +14,7 @@ - + @@ -48,7 +48,7 @@ - + @@ -70,7 +70,7 @@ - + @@ -98,9 +98,9 @@ The offset applied to each vertex. - + 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. @@ -127,10 +127,10 @@ Amount to multiply the [code]uv[/code] coordinates when using a [code]texture[/code]. Larger values make the texture smaller, and vice versa. - + 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]. - + 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]. diff --git a/doc/classes/PolygonPathFinder.xml b/doc/classes/PolygonPathFinder.xml index 28a0447f3d..0b535159a7 100644 --- a/doc/classes/PolygonPathFinder.xml +++ b/doc/classes/PolygonPathFinder.xml @@ -8,7 +8,7 @@ - + @@ -32,7 +32,7 @@ - + @@ -70,9 +70,9 @@ - + - + diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml deleted file mode 100644 index 63a7037fb1..0000000000 --- a/doc/classes/PoolByteArray.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - A pooled [Array] of bytes. - - - An [Array] specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory. - [b]Note:[/b] This type is passed by value and not by reference. - - - - - - - - - - - Constructs a new [PoolByteArray]. Optionally, you can pass in a generic [Array] that will be converted. - - - - - - - Appends an element at the end of the array (alias of [method push_back]). - - - - - - - Appends a [PoolByteArray] at the end of this array. - - - - - - - - - Returns a new [PoolByteArray] with the data compressed. Set the compression mode using one of [enum File.CompressionMode]'s constants. - - - - - - - - - - - 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 [code]true[/code] if the array is empty. - - - - - - - Returns a copy of the array's contents as [String]. Fast alternative to [method get_string_from_utf8] if the content is ASCII-only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use [method get_string_from_utf8]. - - - - - - - Returns a copy of the array's contents as [String]. Slower than [method get_string_from_ascii] but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. - - - - - - - Returns a hexadecimal representation of this array as a [String]. - [codeblock] - var array = PoolByteArray([11, 46, 255]) - print(array.hex_encode()) # Prints: 0b2eff - [/codeblock] - - - - - - - - - - - Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). - - - - - Reverses the order of the elements in the array. - - - - - - - Appends an element at the end of the array. - - - - - - - Removes an element from the array by index. - - - - - - - Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - - - - - - Changes the byte at the given index. - - - - - - - Returns the size of the array. - - - - - - - - - - - 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. - - - - - - diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml deleted file mode 100644 index d5599f821c..0000000000 --- a/doc/classes/PoolColorArray.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - A pooled [Array] of [Color]. - - - An [Array] specifically designed to hold [Color]. Optimized for memory usage, does not fragment the memory. - [b]Note:[/b] This type is passed by value and not by reference. - - - - - - - - - - - Constructs a new [PoolColorArray]. Optionally, you can pass in a generic [Array] that will be converted. - - - - - - - Appends an element at the end of the array (alias of [method push_back]). - - - - - - - Appends a [PoolColorArray] at the end of this array. - - - - - - - Returns [code]true[/code] if the array is empty. - - - - - - - - - - - Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). - - - - - Reverses the order of the elements in the array. - - - - - - - Appends a value to the array. - - - - - - - Removes an element from the array by index. - - - - - - - Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - - - - - - Changes the [Color] at the given index. - - - - - - - Returns the size of the array. - - - - - - diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml deleted file mode 100644 index 54f0f46e11..0000000000 --- a/doc/classes/PoolIntArray.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - A pooled [Array] of integers ([int]). - - - An [Array] specifically designed to hold integer values ([int]). Optimized for memory usage, does not fragment the memory. - [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. - - - - - - - - - - - Constructs a new [PoolIntArray]. Optionally, you can pass in a generic [Array] that will be converted. - - - - - - - Appends an element at the end of the array (alias of [method push_back]). - - - - - - - Appends a [PoolIntArray] at the end of this array. - - - - - - - Returns [code]true[/code] if the array is empty. - - - - - - - - - - - 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]). - - - - - Reverses the order of the elements in the array. - - - - - - - Appends a value to the array. - - - - - - - Removes an element from the array by index. - - - - - - - Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - - - - - - Changes the int at the given index. - - - - - - - Returns the array size. - - - - - - diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml deleted file mode 100644 index 6957e7282b..0000000000 --- a/doc/classes/PoolRealArray.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - A pooled [Array] of reals ([float]). - - - An [Array] specifically designed to hold floating-point values ([float]). Optimized for memory usage, does not fragment the memory. - [b]Note:[/b] This type is passed by value and not by reference. - - - - - - - - - - - Constructs a new [PoolRealArray]. Optionally, you can pass in a generic [Array] that will be converted. - - - - - - - Appends an element at the end of the array (alias of [method push_back]). - - - - - - - Appends a [PoolRealArray] at the end of this array. - - - - - - - Returns [code]true[/code] if the array is empty. - - - - - - - - - - - Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). - - - - - Reverses the order of the elements in the array. - - - - - - - Appends an element at the end of the array. - - - - - - - Removes an element from the array by index. - - - - - - - Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - - - - - - Changes the float at the given index. - - - - - - - Returns the size of the array. - - - - - - diff --git a/doc/classes/PoolStringArray.xml b/doc/classes/PoolStringArray.xml deleted file mode 100644 index b4fb7b31d4..0000000000 --- a/doc/classes/PoolStringArray.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - A pooled [Array] of [String]. - - - An [Array] specifically designed to hold [String]s. Optimized for memory usage, does not fragment the memory. - [b]Note:[/b] This type is passed by value and not by reference. - - - - - - - - - - - Constructs a new [PoolStringArray]. Optionally, you can pass in a generic [Array] that will be converted. - - - - - - - Appends an element at the end of the array (alias of [method push_back]). - - - - - - - Appends a [PoolStringArray] at the end of this array. - - - - - - - Returns [code]true[/code] if the array is empty. - - - - - - - - - - - Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). - - - - - Reverses the order of the elements in the array. - - - - - - - - - Returns a [String] with each element of the array joined with the given [code]delimiter[/code]. - - - - - - - Appends a string element at end of the array. - - - - - - - Removes an element from the array by index. - - - - - - - Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - - - - - - Changes the [String] at the given index. - - - - - - - Returns the size of the array. - - - - - - diff --git a/doc/classes/PoolVector2Array.xml b/doc/classes/PoolVector2Array.xml deleted file mode 100644 index cb4536be5b..0000000000 --- a/doc/classes/PoolVector2Array.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - A pooled [Array] of [Vector2]. - - - An [Array] specifically designed to hold [Vector2]. Optimized for memory usage, does not fragment the memory. - [b]Note:[/b] This type is passed by value and not by reference. - - - - - - - - - - - Constructs a new [PoolVector2Array]. Optionally, you can pass in a generic [Array] that will be converted. - - - - - - - Appends an element at the end of the array (alias of [method push_back]). - - - - - - - Appends a [PoolVector2Array] at the end of this array. - - - - - - - Returns [code]true[/code] if the array is empty. - - - - - - - - - - - Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). - - - - - Reverses the order of the elements in the array. - - - - - - - Inserts a [Vector2] at the end. - - - - - - - Removes an element from the array by index. - - - - - - - Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - - - - - - Changes the [Vector2] at the given index. - - - - - - - Returns the size of the array. - - - - - - diff --git a/doc/classes/PoolVector3Array.xml b/doc/classes/PoolVector3Array.xml deleted file mode 100644 index 6c40de9bd8..0000000000 --- a/doc/classes/PoolVector3Array.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - A pooled [Array] of [Vector3]. - - - An [Array] specifically designed to hold [Vector3]. Optimized for memory usage, does not fragment the memory. - [b]Note:[/b] This type is passed by value and not by reference. - - - - - - - - - - - Constructs a new [PoolVector3Array]. Optionally, you can pass in a generic [Array] that will be converted. - - - - - - - Appends an element at the end of the array (alias of [method push_back]). - - - - - - - Appends a [PoolVector3Array] at the end of this array. - - - - - - - Returns [code]true[/code] if the array is empty. - - - - - - - - - - - Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). - - - - - Reverses the order of the elements in the array. - - - - - - - Inserts a [Vector3] at the end. - - - - - - - Removes an element from the array by index. - - - - - - - Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - - - - - - Changes the [Vector3] at the given index. - - - - - - - Returns the size of the array. - - - - - - diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 0bedb3afe3..014ae95c4b 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -469,7 +469,7 @@ Search path for project-specific script templates. Script templates will be search both in the editor-specific path and in this project-specific path. - + 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. @@ -815,6 +815,18 @@ 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. + + + + + + + + + + + + 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. diff --git a/doc/classes/ResourceFormatLoader.xml b/doc/classes/ResourceFormatLoader.xml index fc36f922e1..828f4cd5d1 100644 --- a/doc/classes/ResourceFormatLoader.xml +++ b/doc/classes/ResourceFormatLoader.xml @@ -24,7 +24,7 @@ - + Gets the list of extensions for files this loader is able to read. diff --git a/doc/classes/ResourceFormatSaver.xml b/doc/classes/ResourceFormatSaver.xml index 369c158ce4..69f8b43898 100644 --- a/doc/classes/ResourceFormatSaver.xml +++ b/doc/classes/ResourceFormatSaver.xml @@ -11,7 +11,7 @@ - + diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index 85c9438d4f..d2a0ac22d6 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -24,7 +24,7 @@ - + @@ -33,7 +33,7 @@ - + diff --git a/doc/classes/ResourcePreloader.xml b/doc/classes/ResourcePreloader.xml index 1e0dcaaea8..b1e8096c3a 100644 --- a/doc/classes/ResourcePreloader.xml +++ b/doc/classes/ResourcePreloader.xml @@ -31,7 +31,7 @@ - + Returns the list of resources inside the preloader. diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml index 8c27b951f5..ecde5754f9 100644 --- a/doc/classes/ResourceSaver.xml +++ b/doc/classes/ResourceSaver.xml @@ -11,7 +11,7 @@ - + diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 983f768b85..5f07133a27 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -113,7 +113,7 @@ - + Parses BBCode parameter [code]expressions[/code] into a dictionary. diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml index 7304e03bf6..2fcb831270 100644 --- a/doc/classes/SceneState.xml +++ b/doc/classes/SceneState.xml @@ -81,7 +81,7 @@ - + diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 1499173d6b..b1d559986c 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -83,7 +83,7 @@ - + Returns the peer IDs of all connected peers of this [SceneTree]'s [member network_peer]. @@ -320,7 +320,7 @@ - + diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index fe4b888a3c..a4f24f0603 100644 --- a/doc/classes/SpriteFrames.xml +++ b/doc/classes/SpriteFrames.xml @@ -57,7 +57,7 @@ - + Returns an array containing the names associated to each animation. Values are placed in alphabetical order. diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index 31742199dd..a73d3c8212 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -171,7 +171,7 @@ - + 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 @@ - + 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. diff --git a/doc/classes/StreamPeerBuffer.xml b/doc/classes/StreamPeerBuffer.xml index 23e3890fdb..41cef9fb55 100644 --- a/doc/classes/StreamPeerBuffer.xml +++ b/doc/classes/StreamPeerBuffer.xml @@ -49,7 +49,7 @@ - + diff --git a/doc/classes/String.xml b/doc/classes/String.xml index cb80d04f24..fdf4e780de 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -166,64 +166,64 @@ - + - Constructs a new String from the given [PoolByteArray]. + Constructs a new String from the given [PackedByteArray]. - + - Constructs a new String from the given [PoolIntArray]. + Constructs a new String from the given [PackedIntArray]. - + - Constructs a new String from the given [PoolRealArray]. + Constructs a new String from the given [PackedRealArray]. - + - Constructs a new String from the given [PoolStringArray]. + Constructs a new String from the given [PackedStringArray]. - + - Constructs a new String from the given [PoolVector2Array]. + Constructs a new String from the given [PackedVector2Array]. - + - Constructs a new String from the given [PoolVector3Array]. + Constructs a new String from the given [PackedVector3Array]. - + - Constructs a new String from the given [PoolColorArray]. + Constructs a new String from the given [PackedColorArray]. @@ -236,7 +236,7 @@ - + Returns the bigrams (pairs of consecutive letters) of this string. @@ -597,7 +597,7 @@ - + Returns the MD5 hash of the string as an array of bytes. @@ -732,7 +732,7 @@ - + @@ -764,7 +764,7 @@ - + Returns the SHA-1 hash of the string as an array of bytes. @@ -778,7 +778,7 @@ - + Returns the SHA-256 hash of the string as an array of bytes. @@ -801,7 +801,7 @@ - + @@ -823,7 +823,7 @@ - + @@ -864,10 +864,10 @@ - + - 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. @@ -899,10 +899,10 @@ - + - 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]. diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index 23363fcad5..a265d16cd9 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -22,7 +22,7 @@ - + Adds an array of bones for the next vertex to use. [code]bones[/code] must contain 4 integers. @@ -76,15 +76,15 @@ - + - + - + - + - + @@ -123,7 +123,7 @@ - + Specifies weight values for next vertex to use. [code]weights[/code] must contain 4 values. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index c4a05db3a7..2ab8b939c7 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -299,7 +299,7 @@ - + @@ -311,7 +311,7 @@ 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() > 0: diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index d11cfc7aa2..45f49e7b31 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -101,12 +101,12 @@ - + - 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]. @@ -121,12 +121,12 @@ - + - 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]. @@ -141,12 +141,12 @@ - + - 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]. @@ -161,12 +161,12 @@ - + - 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]. @@ -181,28 +181,28 @@ - + - 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]. - + - 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]. - + - 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]. diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index e9d7208f66..e4d367c344 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -154,7 +154,7 @@ - Transforms the given [Vector3], [Plane], [AABB], or [PoolVector3Array] by this transform. + Transforms the given [Vector3], [Plane], [AABB], or [PackedVector3Array] by this transform. @@ -163,7 +163,7 @@ - Inverse-transforms the given [Vector3], [Plane], [AABB], or [PoolVector3Array] by this transform. + Inverse-transforms the given [Vector3], [Plane], [AABB], or [PackedVector3Array] by this transform. diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 9719326f59..af93d4c654 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -156,7 +156,7 @@ - Transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform. + Transforms the given [Vector2], [Rect2], or [PackedVector2Array] by this transform. @@ -165,7 +165,7 @@ - Inverse-transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform. + Inverse-transforms the given [Vector2], [Rect2], or [PackedVector2Array] by this transform. diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml index f80e59f6f9..c0c5a3ffbd 100644 --- a/doc/classes/Translation.xml +++ b/doc/classes/Translation.xml @@ -48,7 +48,7 @@ - + Returns all the messages (keys). diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index c51811397a..de8bb2c33f 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -540,7 +540,7 @@ - + @@ -553,7 +553,7 @@ - + Sets the shape of the occluder polygon as lines. @@ -1564,7 +1564,7 @@ - + @@ -1617,7 +1617,7 @@ - + Sets the octree to be used by this lightmap capture. @@ -1902,7 +1902,7 @@ - + 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 @@ - + @@ -2078,7 +2078,7 @@ - + diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index 44e843f8a5..99ba665979 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -107,7 +107,7 @@ - + diff --git a/doc/classes/XMLParser.xml b/doc/classes/XMLParser.xml index 8140fde62d..2849ea62ab 100644 --- a/doc/classes/XMLParser.xml +++ b/doc/classes/XMLParser.xml @@ -115,7 +115,7 @@ - + Opens an XML raw buffer for parsing. This returns an error code. -- cgit v1.2.3