From c5d7115038de5f83cb83e08748615a84fc26bee2 Mon Sep 17 00:00:00 2001 From: Yuri Sizov Date: Sat, 6 Aug 2022 21:11:48 +0300 Subject: Rename the argument tag to param in XML documentation --- doc/classes/@GlobalScope.xml | 270 +-- doc/classes/AABB.xml | 42 +- doc/classes/AESContext.xml | 8 +- doc/classes/AStar2D.xml | 72 +- doc/classes/AStar3D.xml | 72 +- doc/classes/AcceptDialog.xml | 14 +- doc/classes/AnimatedSprite2D.xml | 4 +- doc/classes/AnimatedSprite3D.xml | 2 +- doc/classes/AnimatedTexture.xml | 12 +- doc/classes/Animation.xml | 292 +-- doc/classes/AnimationLibrary.xml | 22 +- doc/classes/AnimationNode.xml | 72 +- doc/classes/AnimationNodeBlendSpace1D.xml | 20 +- doc/classes/AnimationNodeBlendSpace2D.xml | 34 +- doc/classes/AnimationNodeBlendTree.xml | 32 +- doc/classes/AnimationNodeStateMachine.xml | 52 +- doc/classes/AnimationNodeStateMachinePlayback.xml | 4 +- doc/classes/AnimationNodeTransition.xml | 12 +- doc/classes/AnimationPlayer.xml | 68 +- doc/classes/AnimationTree.xml | 6 +- doc/classes/Area2D.xml | 44 +- doc/classes/Area3D.xml | 44 +- doc/classes/Array.xml | 106 +- doc/classes/ArrayMesh.xml | 56 +- doc/classes/ArrayOccluder3D.xml | 4 +- doc/classes/AudioEffectCapture.xml | 4 +- doc/classes/AudioEffectChorus.xml | 36 +- doc/classes/AudioEffectEQ.xml | 6 +- doc/classes/AudioEffectInstance.xml | 6 +- doc/classes/AudioEffectRecord.xml | 2 +- .../AudioEffectSpectrumAnalyzerInstance.xml | 6 +- doc/classes/AudioServer.xml | 98 +- doc/classes/AudioStreamGeneratorPlayback.xml | 6 +- doc/classes/AudioStreamPlayback.xml | 10 +- doc/classes/AudioStreamPlaybackResampled.xml | 4 +- doc/classes/AudioStreamPlayer.xml | 4 +- doc/classes/AudioStreamPlayer2D.xml | 4 +- doc/classes/AudioStreamPlayer3D.xml | 4 +- doc/classes/AudioStreamRandomizer.xml | 20 +- doc/classes/AudioStreamWAV.xml | 2 +- doc/classes/BaseButton.xml | 6 +- doc/classes/BaseMaterial3D.xml | 18 +- doc/classes/Basis.xml | 58 +- doc/classes/BitMap.xml | 26 +- doc/classes/Bone2D.xml | 8 +- doc/classes/BoneAttachment3D.xml | 10 +- doc/classes/BoneMap.xml | 8 +- doc/classes/BoxContainer.xml | 2 +- doc/classes/ButtonGroup.xml | 2 +- doc/classes/CPUParticles2D.xml | 26 +- doc/classes/CPUParticles3D.xml | 26 +- doc/classes/Callable.xml | 14 +- doc/classes/CallbackTweener.xml | 2 +- doc/classes/Camera2D.xml | 12 +- doc/classes/Camera3D.xml | 44 +- doc/classes/CameraServer.xml | 10 +- doc/classes/CanvasItem.xml | 298 +-- doc/classes/CharacterBody2D.xml | 4 +- doc/classes/CharacterBody3D.xml | 4 +- doc/classes/ClassDB.xml | 86 +- doc/classes/CodeEdit.xml | 122 +- doc/classes/CodeHighlighter.xml | 32 +- doc/classes/CollisionObject2D.xml | 80 +- doc/classes/CollisionObject3D.xml | 72 +- doc/classes/CollisionShape3D.xml | 2 +- doc/classes/Color.xml | 102 +- doc/classes/ColorPicker.xml | 10 +- doc/classes/ColorPickerButton.xml | 2 +- doc/classes/CompressedTexture2D.xml | 2 +- doc/classes/CompressedTexture3D.xml | 2 +- doc/classes/CompressedTextureLayered.xml | 2 +- doc/classes/ConcavePolygonShape3D.xml | 2 +- doc/classes/ConeTwistJoint3D.xml | 6 +- doc/classes/ConfigFile.xml | 48 +- doc/classes/Container.xml | 4 +- doc/classes/Control.xml | 194 +- doc/classes/ConvexPolygonShape2D.xml | 2 +- doc/classes/Crypto.xml | 44 +- doc/classes/CryptoKey.xml | 14 +- doc/classes/Curve.xml | 50 +- doc/classes/Curve2D.xml | 46 +- doc/classes/Curve3D.xml | 56 +- doc/classes/DTLSServer.xml | 8 +- doc/classes/Decal.xml | 6 +- doc/classes/Dictionary.xml | 24 +- doc/classes/Directory.xml | 24 +- doc/classes/DisplayServer.xml | 488 ++--- doc/classes/EditorCommandPalette.xml | 10 +- doc/classes/EditorDebuggerPlugin.xml | 14 +- doc/classes/EditorExportPlugin.xml | 42 +- doc/classes/EditorFeatureProfile.xml | 34 +- doc/classes/EditorFileDialog.xml | 10 +- doc/classes/EditorFileSystem.xml | 14 +- doc/classes/EditorFileSystemDirectory.xml | 18 +- doc/classes/EditorImportPlugin.xml | 22 +- doc/classes/EditorInspector.xml | 22 +- doc/classes/EditorInspectorPlugin.xml | 42 +- doc/classes/EditorInterface.xml | 42 +- doc/classes/EditorNode3DGizmo.xml | 90 +- doc/classes/EditorNode3DGizmoPlugin.xml | 106 +- doc/classes/EditorPlugin.xml | 124 +- doc/classes/EditorProperty.xml | 52 +- doc/classes/EditorResourceConversionPlugin.xml | 4 +- doc/classes/EditorResourcePicker.xml | 12 +- doc/classes/EditorResourcePreview.xml | 24 +- doc/classes/EditorResourcePreviewGenerator.xml | 10 +- doc/classes/EditorSceneFormatImporter.xml | 16 +- doc/classes/EditorScenePostImport.xml | 2 +- doc/classes/EditorScenePostImportPlugin.xml | 50 +- doc/classes/EditorScript.xml | 2 +- doc/classes/EditorSelection.xml | 4 +- doc/classes/EditorSettings.xml | 46 +- doc/classes/EditorTranslationParserPlugin.xml | 6 +- doc/classes/EditorVCSInterface.xml | 10 +- doc/classes/Engine.xml | 14 +- doc/classes/EngineDebugger.xml | 32 +- doc/classes/EngineProfiler.xml | 14 +- doc/classes/Environment.xml | 6 +- doc/classes/Expression.xml | 12 +- doc/classes/File.xml | 72 +- doc/classes/FileDialog.xml | 10 +- doc/classes/FileSystemDock.xml | 18 +- doc/classes/Font.xml | 182 +- doc/classes/FontFile.xml | 278 +-- doc/classes/FontVariation.xml | 4 +- doc/classes/GPUParticles2D.xml | 10 +- doc/classes/GPUParticles3D.xml | 16 +- doc/classes/GPUParticlesCollisionSDF3D.xml | 6 +- doc/classes/Generic6DOFJoint3D.xml | 36 +- doc/classes/Geometry2D.xml | 110 +- doc/classes/Geometry3D.xml | 86 +- doc/classes/GeometryInstance3D.xml | 8 +- doc/classes/Gradient.xml | 20 +- doc/classes/GraphEdit.xml | 128 +- doc/classes/GraphNode.xml | 88 +- doc/classes/HMACContext.xml | 6 +- doc/classes/HTTPClient.xml | 34 +- doc/classes/HTTPRequest.xml | 36 +- doc/classes/HashingContext.xml | 4 +- doc/classes/HingeJoint3D.xml | 12 +- doc/classes/IP.xml | 22 +- doc/classes/Image.xml | 158 +- doc/classes/ImageTexture.xml | 8 +- doc/classes/ImageTexture3D.xml | 14 +- doc/classes/ImageTextureLayered.xml | 6 +- doc/classes/ImmediateMesh.xml | 18 +- doc/classes/ImporterMesh.xml | 60 +- doc/classes/Input.xml | 106 +- doc/classes/InputEvent.xml | 28 +- doc/classes/InputMap.xml | 36 +- doc/classes/InstancePlaceholder.xml | 6 +- doc/classes/ItemList.xml | 130 +- doc/classes/JSON.xml | 10 +- doc/classes/JSONRPC.xml | 30 +- doc/classes/JavaClassWrapper.xml | 2 +- doc/classes/JavaScript.xml | 16 +- doc/classes/KinematicCollision2D.xml | 2 +- doc/classes/KinematicCollision3D.xml | 22 +- doc/classes/Label.xml | 2 +- doc/classes/Label3D.xml | 6 +- doc/classes/Light2D.xml | 2 +- doc/classes/Light3D.xml | 6 +- doc/classes/LightmapGIData.xml | 12 +- doc/classes/Line2D.xml | 12 +- doc/classes/LineEdit.xml | 18 +- doc/classes/MainLoop.xml | 8 +- doc/classes/Marshalls.xml | 16 +- doc/classes/MenuButton.xml | 2 +- doc/classes/Mesh.xml | 42 +- doc/classes/MeshDataTool.xml | 94 +- doc/classes/MeshInstance3D.xml | 20 +- doc/classes/MeshLibrary.xml | 48 +- doc/classes/MethodTweener.xml | 6 +- doc/classes/MovieWriter.xml | 14 +- doc/classes/MultiMesh.xml | 24 +- doc/classes/MultiplayerAPI.xml | 22 +- doc/classes/MultiplayerAPIExtension.xml | 18 +- doc/classes/MultiplayerPeer.xml | 6 +- doc/classes/MultiplayerPeerExtension.xml | 18 +- doc/classes/NativeExtension.xml | 6 +- doc/classes/NativeExtensionManager.xml | 10 +- doc/classes/NavigationAgent2D.xml | 14 +- doc/classes/NavigationAgent3D.xml | 14 +- doc/classes/NavigationMesh.xml | 14 +- doc/classes/NavigationMeshGenerator.xml | 6 +- doc/classes/NavigationPolygon.xml | 20 +- doc/classes/NavigationRegion2D.xml | 6 +- doc/classes/NavigationRegion3D.xml | 8 +- doc/classes/NavigationServer2D.xml | 140 +- doc/classes/NavigationServer3D.xml | 166 +- doc/classes/NinePatchRect.xml | 6 +- doc/classes/Node.xml | 136 +- doc/classes/Node2D.xml | 26 +- doc/classes/Node3D.xml | 62 +- doc/classes/NodePath.xml | 12 +- doc/classes/OS.xml | 82 +- doc/classes/Object.xml | 96 +- doc/classes/OccluderInstance3D.xml | 6 +- doc/classes/OptimizedTranslation.xml | 2 +- doc/classes/OptionButton.xml | 62 +- doc/classes/PCKPacker.xml | 16 +- doc/classes/PackedByteArray.xml | 146 +- doc/classes/PackedColorArray.xml | 52 +- doc/classes/PackedDataContainer.xml | 2 +- doc/classes/PackedFloat32Array.xml | 52 +- doc/classes/PackedFloat64Array.xml | 52 +- doc/classes/PackedInt32Array.xml | 52 +- doc/classes/PackedInt64Array.xml | 52 +- doc/classes/PackedScene.xml | 4 +- doc/classes/PackedStringArray.xml | 52 +- doc/classes/PackedVector2Array.xml | 54 +- doc/classes/PackedVector3Array.xml | 54 +- doc/classes/PacketPeer.xml | 8 +- doc/classes/PacketPeerDTLS.xml | 8 +- doc/classes/PacketPeerExtension.xml | 8 +- doc/classes/PacketPeerUDP.xml | 24 +- doc/classes/ParticlesMaterial.xml | 24 +- doc/classes/Performance.xml | 14 +- doc/classes/PhysicalBone3D.xml | 8 +- doc/classes/PhysicsBody2D.xml | 18 +- doc/classes/PhysicsBody3D.xml | 28 +- doc/classes/PhysicsDirectBodyState2D.xml | 48 +- doc/classes/PhysicsDirectBodyState3D.xml | 50 +- doc/classes/PhysicsDirectBodyState3DExtension.xml | 58 +- doc/classes/PhysicsDirectSpaceState2D.xml | 18 +- doc/classes/PhysicsDirectSpaceState3D.xml | 18 +- doc/classes/PhysicsDirectSpaceState3DExtension.xml | 106 +- doc/classes/PhysicsRayQueryParameters2D.xml | 8 +- doc/classes/PhysicsRayQueryParameters3D.xml | 8 +- doc/classes/PhysicsServer2D.xml | 388 ++-- doc/classes/PhysicsServer3D.xml | 484 ++--- doc/classes/PhysicsServer3DExtension.xml | 492 ++--- .../PhysicsServer3DRenderingServerHandler.xml | 10 +- doc/classes/PhysicsTestMotionResult3D.xml | 18 +- doc/classes/PinJoint3D.xml | 6 +- doc/classes/Plane.xml | 56 +- doc/classes/Polygon2D.xml | 18 +- doc/classes/PolygonPathFinder.xml | 22 +- doc/classes/PopupMenu.xml | 230 +-- doc/classes/PortableCompressedTexture2D.xml | 10 +- doc/classes/ProjectSettings.xml | 38 +- doc/classes/Projection.xml | 120 +- doc/classes/PropertyTweener.xml | 8 +- doc/classes/Quaternion.xml | 66 +- doc/classes/RDShaderFile.xml | 6 +- doc/classes/RDShaderSPIRV.xml | 12 +- doc/classes/RDShaderSource.xml | 6 +- doc/classes/RDTextureFormat.xml | 4 +- doc/classes/RDUniform.xml | 2 +- doc/classes/RID.xml | 14 +- doc/classes/RandomNumberGenerator.xml | 12 +- doc/classes/Range.xml | 6 +- doc/classes/RayCast2D.xml | 14 +- doc/classes/RayCast3D.xml | 14 +- doc/classes/Rect2.xml | 52 +- doc/classes/Rect2i.xml | 46 +- doc/classes/RenderingDevice.xml | 394 ++-- doc/classes/RenderingServer.xml | 1952 ++++++++++---------- doc/classes/Resource.xml | 4 +- doc/classes/ResourceFormatLoader.xml | 26 +- doc/classes/ResourceFormatSaver.xml | 10 +- doc/classes/ResourceLoader.xml | 40 +- doc/classes/ResourcePreloader.xml | 14 +- doc/classes/ResourceSaver.xml | 14 +- doc/classes/ResourceUID.xml | 18 +- doc/classes/RichTextEffect.xml | 2 +- doc/classes/RichTextLabel.xml | 112 +- doc/classes/RigidDynamicBody2D.xml | 48 +- doc/classes/RigidDynamicBody3D.xml | 48 +- doc/classes/SceneState.xml | 44 +- doc/classes/SceneTree.xml | 66 +- doc/classes/Script.xml | 8 +- doc/classes/ScriptCreateDialog.xml | 10 +- doc/classes/ScriptEditor.xml | 14 +- doc/classes/ScriptEditorBase.xml | 14 +- doc/classes/ScriptExtension.xml | 24 +- doc/classes/ScriptLanguageExtension.xml | 126 +- doc/classes/ScrollContainer.xml | 2 +- doc/classes/Shader.xml | 12 +- doc/classes/ShaderMaterial.xml | 10 +- doc/classes/Shape2D.xml | 36 +- doc/classes/ShapeCast2D.xml | 22 +- doc/classes/ShapeCast3D.xml | 24 +- doc/classes/Shortcut.xml | 2 +- doc/classes/Signal.xml | 18 +- doc/classes/Skeleton2D.xml | 18 +- doc/classes/Skeleton3D.xml | 126 +- doc/classes/SkeletonIK3D.xml | 2 +- doc/classes/SkeletonModification2D.xml | 16 +- doc/classes/SkeletonModification2DCCDIK.xml | 42 +- doc/classes/SkeletonModification2DFABRIK.xml | 24 +- doc/classes/SkeletonModification2DJiggle.xml | 52 +- doc/classes/SkeletonModification2DLookAt.xml | 10 +- .../SkeletonModification2DPhysicalBones.xml | 10 +- doc/classes/SkeletonModification2DStackHolder.xml | 2 +- doc/classes/SkeletonModification2DTwoBoneIK.xml | 8 +- doc/classes/SkeletonModification3D.xml | 14 +- doc/classes/SkeletonModification3DCCDIK.xml | 42 +- doc/classes/SkeletonModification3DFABRIK.xml | 50 +- doc/classes/SkeletonModification3DJiggle.xml | 58 +- doc/classes/SkeletonModification3DLookAt.xml | 6 +- doc/classes/SkeletonModification3DStackHolder.xml | 2 +- doc/classes/SkeletonModification3DTwoBoneIK.xml | 26 +- doc/classes/SkeletonModificationStack2D.xml | 16 +- doc/classes/SkeletonModificationStack3D.xml | 16 +- doc/classes/SkeletonProfile.xml | 56 +- doc/classes/Skin.xml | 28 +- doc/classes/Slider.xml | 2 +- doc/classes/SliderJoint3D.xml | 6 +- doc/classes/SoftDynamicBody3D.xml | 26 +- doc/classes/SplitContainer.xml | 2 +- doc/classes/SpringArm3D.xml | 4 +- doc/classes/Sprite2D.xml | 2 +- doc/classes/SpriteBase3D.xml | 6 +- doc/classes/SpriteFrames.xml | 46 +- doc/classes/StreamPeer.xml | 42 +- doc/classes/StreamPeerBuffer.xml | 4 +- doc/classes/StreamPeerExtension.xml | 24 +- doc/classes/StreamPeerSSL.xml | 16 +- doc/classes/StreamPeerTCP.xml | 10 +- doc/classes/String.xml | 190 +- doc/classes/StringName.xml | 20 +- doc/classes/StyleBox.xml | 28 +- doc/classes/StyleBoxFlat.xml | 40 +- doc/classes/StyleBoxTexture.xml | 22 +- doc/classes/SurfaceTool.xml | 74 +- doc/classes/SyntaxHighlighter.xml | 4 +- doc/classes/TCPServer.xml | 4 +- doc/classes/TabBar.xml | 74 +- doc/classes/TabContainer.xml | 44 +- doc/classes/TextEdit.xml | 250 +-- doc/classes/TextLine.xml | 46 +- doc/classes/TextParagraph.xml | 112 +- doc/classes/TextServer.xml | 758 ++++---- doc/classes/TextServerExtension.xml | 770 ++++---- doc/classes/TextServerManager.xml | 14 +- doc/classes/Texture2D.xml | 64 +- doc/classes/TextureLayered.xml | 4 +- doc/classes/TextureProgressBar.xml | 6 +- doc/classes/Theme.xml | 216 +-- doc/classes/Thread.xml | 4 +- doc/classes/TileData.xml | 84 +- doc/classes/TileMap.xml | 140 +- doc/classes/TileMapPattern.xml | 22 +- doc/classes/TileSet.xml | 222 +-- doc/classes/TileSetAtlasSource.xml | 100 +- doc/classes/TileSetScenesCollectionSource.xml | 26 +- doc/classes/TileSetSource.xml | 14 +- doc/classes/Time.xml | 42 +- doc/classes/Timer.xml | 2 +- doc/classes/Transform2D.xml | 68 +- doc/classes/Transform3D.xml | 64 +- doc/classes/Translation.xml | 40 +- doc/classes/TranslationServer.xml | 36 +- doc/classes/Tree.xml | 100 +- doc/classes/TreeItem.xml | 248 +-- doc/classes/Tween.xml | 54 +- doc/classes/UDPServer.xml | 4 +- doc/classes/UndoRedo.xml | 34 +- doc/classes/Vector2.xml | 108 +- doc/classes/Vector2i.xml | 46 +- doc/classes/Vector3.xml | 120 +- doc/classes/Vector3i.xml | 48 +- doc/classes/Vector4.xml | 74 +- doc/classes/Vector4i.xml | 50 +- doc/classes/VelocityTracker3D.xml | 4 +- doc/classes/Viewport.xml | 24 +- doc/classes/VisualInstance3D.xml | 8 +- doc/classes/VisualShader.xml | 100 +- doc/classes/VisualShaderNode.xml | 12 +- doc/classes/VisualShaderNodeCustom.xml | 26 +- doc/classes/VisualShaderNodeGroupBase.xml | 42 +- doc/classes/VoxelGI.xml | 4 +- doc/classes/VoxelGIData.xml | 14 +- doc/classes/Window.xml | 78 +- doc/classes/WorkerThreadPool.xml | 26 +- doc/classes/X509Certificate.xml | 4 +- doc/classes/XMLParser.xml | 16 +- doc/classes/XRController3D.xml | 18 +- doc/classes/XRInterface.xml | 18 +- doc/classes/XRInterfaceExtension.xml | 64 +- doc/classes/XRNode3D.xml | 10 +- doc/classes/XRPositionalTracker.xml | 38 +- doc/classes/XRServer.xml | 36 +- doc/classes/bool.xml | 14 +- doc/classes/float.xml | 66 +- doc/classes/int.xml | 80 +- 387 files changed, 10017 insertions(+), 10017 deletions(-) (limited to 'doc/classes') diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 7a75823230..05e4e209d1 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -14,7 +14,7 @@ - + Returns the absolute value of a [Variant] parameter [code]x[/code] (i.e. non-negative value). Variant types [int], [float] (real), [Vector2], [Vector2i], [Vector3] and [Vector3i] are supported. [codeblock] @@ -40,7 +40,7 @@ - + Returns the absolute value of float parameter [code]x[/code] (i.e. positive value). [codeblock] @@ -51,7 +51,7 @@ - + Returns the absolute value of int parameter [code]x[/code] (i.e. positive value). [codeblock] @@ -62,7 +62,7 @@ - + Returns the arc cosine of [code]x[/code] in radians. Use to get the angle of cosine [code]x[/code]. [code]x[/code] must be between [code]-1.0[/code] and [code]1.0[/code] (inclusive), otherwise, [method acos] will return [constant @GDScript.NAN]. [codeblock] @@ -73,7 +73,7 @@ - + Returns the arc sine of [code]x[/code] in radians. Use to get the angle of sine [code]x[/code]. [code]x[/code] must be between [code]-1.0[/code] and [code]1.0[/code] (inclusive), otherwise, [method asin] will return [constant @GDScript.NAN]. [codeblock] @@ -84,7 +84,7 @@ - + Returns the arc tangent of [code]x[/code] in radians. Use it to get the angle from an angle's tangent in trigonometry. The method cannot know in which quadrant the angle should fall. See [method atan2] if you have both [code]y[/code] and [code]x[/code]. @@ -96,8 +96,8 @@ - - + + Returns the arc tangent of [code]y/x[/code] in radians. Use to get the angle of tangent [code]y/x[/code]. To compute the value, the method takes into account the sign of both arguments in order to determine the quadrant. Important note: The Y coordinate comes first, by convention. @@ -108,18 +108,18 @@ - - - - - + + + + + Returns the point at the given [code]t[/code] on a one-dimnesional [url=https://en.wikipedia.org/wiki/B%C3%A9zier_curve]Bezier curve[/url] defined by the given [code]control_1[/code], [code]control_2[/code], and [code]end[/code] points. - + Decodes a byte array back to a [Variant] value, without decoding objects. [b]Note:[/b] If you need object deserialization, see [method bytes2var_with_objects]. @@ -127,7 +127,7 @@ - + Decodes a byte array back to a [Variant] value. Decoding objects is allowed. [b]Warning:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). @@ -135,7 +135,7 @@ - + Rounds [code]x[/code] upward (towards positive infinity), returning the smallest whole number that is not less than [code]x[/code]. Supported types: [int], [float], [Vector2], [Vector3], [Vector4]. [codeblock] @@ -148,7 +148,7 @@ - + Rounds [code]x[/code] upward (towards positive infinity), returning the smallest whole number that is not less than [code]x[/code]. A type-safe version of [method ceil], specialzied in floats. @@ -156,7 +156,7 @@ - + Rounds [code]x[/code] upward (towards positive infinity), returning the smallest whole number that is not less than [code]x[/code]. A type-safe version of [method ceil] that returns integer. @@ -164,9 +164,9 @@ - - - + + + Clamps the [Variant] [code]value[/code] and returns a value not less than [code]min[/code] and not more than [code]max[/code]. Variant types [int], [float] (real), [Vector2], [Vector2i], [Vector3] and [Vector3i] are supported. [codeblock] @@ -192,9 +192,9 @@ - - - + + + Clamps the float [code]value[/code] and returns a value not less than [code]min[/code] and not more than [code]max[/code]. [codeblock] @@ -210,9 +210,9 @@ - - - + + + Clamps the integer [code]value[/code] and returns a value not less than [code]min[/code] and not more than [code]max[/code]. [codeblock] @@ -228,7 +228,7 @@ - + Returns the cosine of angle [code]angle_rad[/code] in radians. [codeblock] @@ -240,7 +240,7 @@ - + Returns the hyperbolic cosine of [code]x[/code] in radians. [codeblock] @@ -251,25 +251,25 @@ - - - - - + + + + + Cubic interpolates between two values by the factor defined in [code]weight[/code] with pre and post values. - + Converts from decibels to linear energy (audio). - + Converts an angle expressed in degrees to radians. [codeblock] @@ -280,8 +280,8 @@ - - + + Returns an "eased" value of [code]x[/code] based on an easing function defined with [code]curve[/code]. This easing function is based on an exponent. The [code]curve[/code] can be any floating-point number, with specific values leading to the following behaviors: [codeblock] @@ -299,14 +299,14 @@ - + Returns a human-readable name for the given error code. - + The natural exponential function. It raises the mathematical constant [b]e[/b] to the power of [code]x[/code] and returns it. [b]e[/b] has an approximate value of 2.71828, and can be obtained with [code]exp(1)[/code]. @@ -318,7 +318,7 @@ - + Rounds [code]x[/code] downward (towards negative infinity), returning the largest whole number that is not more than [code]x[/code]. Supported types: [int], [float], [Vector2], [Vector3], [Vector4]. [codeblock] @@ -333,7 +333,7 @@ - + Rounds [code]x[/code] downward (towards negative infinity), returning the largest whole number that is not more than [code]x[/code]. A type-safe version of [method floor], specialzied in floats. @@ -341,7 +341,7 @@ - + Rounds [code]x[/code] downward (towards negative infinity), returning the largest whole number that is not more than [code]x[/code]. Equivalent of doing [code]int(x)[/code]. @@ -349,8 +349,8 @@ - - + + Returns the floating-point remainder of [code]x/y[/code], keeping the sign of [code]x[/code]. [codeblock] @@ -362,8 +362,8 @@ - - + + Returns the floating-point modulus of [code]x/y[/code] that wraps equally in positive and negative. [codeblock] @@ -385,7 +385,7 @@ - + Returns the integer hash of the variable passed. [codeblock] @@ -395,7 +395,7 @@ - + Returns the Object that corresponds to [code]instance_id[/code]. All Objects have a unique instance ID. [codeblock] @@ -409,9 +409,9 @@ - - - + + + Returns an interpolation or extrapolation factor considering the range specified in [code]from[/code] and [code]to[/code], and the interpolated value specified in [code]weight[/code]. The returned value will be between [code]0.0[/code] and [code]1.0[/code] if [code]weight[/code] is between [code]from[/code] and [code]to[/code] (inclusive). If [code]weight[/code] is located outside this range, then an extrapolation factor will be returned (return value lower than [code]0.0[/code] or greater than [code]1.0[/code]). Use [method clamp] on the result of [method inverse_lerp] if this is not desired. [codeblock] @@ -427,8 +427,8 @@ - - + + Returns [code]true[/code] if [code]a[/code] and [code]b[/code] are approximately equal to each other. Here, approximately equal means that [code]a[/code] and [code]b[/code] are within a small internal epsilon of each other, which scales with the magnitude of the numbers. @@ -437,35 +437,35 @@ - + Returns whether [code]x[/code] is an infinity value (either positive infinity or negative infinity). - + Returns [code]true[/code] if the Object that corresponds to [code]instance_id[/code] is a valid object (e.g. has not been deleted from memory). All Objects have a unique instance ID. - + Returns whether [code]instance[/code] is a valid object (e.g. has not been deleted from memory). - + Returns whether [code]x[/code] is a NaN ("Not a Number" or invalid) value. - + Returns [code]true[/code] if [code]x[/code] is zero or almost zero. This method is faster than using [method is_equal_approx] with one value as zero. @@ -473,9 +473,9 @@ - - - + + + Linearly interpolates between two values by the factor defined in [code]weight[/code]. To perform interpolation, [code]weight[/code] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). However, values outside this range are allowed and can be used to perform [i]extrapolation[/i]. Use [method clamp] on the result of [method lerp] if this is not desired. Both [code]from[/code] and [code]to[/code] must have matching types. Supported types: [float], [Vector2], [Vector3], [Vector4], [Color], [Quaternion], [Basis]. @@ -488,9 +488,9 @@ - - - + + + Linearly interpolates between two angles (in radians) by a normalized value. Similar to [method lerp], but interpolates correctly when the angles wrap around [constant @GDScript.TAU]. To perform eased interpolation with [method lerp_angle], combine it with [method ease] or [method smoothstep]. @@ -508,9 +508,9 @@ - - - + + + Linearly interpolates between two values by the factor defined in [code]weight[/code]. To perform interpolation, [code]weight[/code] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). However, values outside this range are allowed and can be used to perform [i]extrapolation[/i]. [codeblock] @@ -521,7 +521,7 @@ - + Converts from linear energy to decibels (audio). This can be used to implement volume sliders that behave as expected (since volume isn't linear). Example: [codeblock] @@ -534,7 +534,7 @@ - + Natural logarithm. The amount of time needed to reach a certain level of continuous growth. [b]Note:[/b] This is not the same as the "log" function on most calculators, which uses a base 10 logarithm. @@ -555,8 +555,8 @@ - - + + Returns the maximum of two float values. [codeblock] @@ -567,8 +567,8 @@ - - + + Returns the maximum of two int values. [codeblock] @@ -588,8 +588,8 @@ - - + + Returns the minimum of two float values. [codeblock] @@ -600,8 +600,8 @@ - - + + Returns the minimum of two int values. [codeblock] @@ -612,9 +612,9 @@ - - - + + + Moves [code]from[/code] toward [code]to[/code] by the [code]delta[/code] value. Use a negative [code]delta[/code] value to move away. @@ -627,7 +627,7 @@ - + Returns the nearest equal or larger power of 2 for integer [code]value[/code]. In other words, returns the smallest value [code]a[/code] where [code]a = pow(2, n)[/code] such that [code]value <= a[/code] for some non-negative integer [code]n[/code]. @@ -644,8 +644,8 @@ - - + + Returns the [code]value[/code] wrapped between [code]0[/code] and the [code]length[/code]. If the limit is reached, the next value the function returned is decreased to the [code]0[/code] side or increased to the [code]length[/code] side (like a triangle wave). If [code]length[/code] is less than zero, it becomes positive. [codeblock] @@ -664,8 +664,8 @@ - - + + Returns the integer modulus of [code]x/y[/code] that wraps equally in positive and negative. [codeblock] @@ -686,8 +686,8 @@ - - + + Returns the result of [code]base[/code] raised to the power of [code]exp[/code]. [codeblock] @@ -774,7 +774,7 @@ - + Converts an angle expressed in radians to degrees. [codeblock] @@ -784,7 +784,7 @@ - + Random from seed: pass a [code]seed[/code], and an array with both number and new seed is returned. "Seed" here refers to the internal state of the pseudo random number generator. The internal state of the current implementation is 64 bits. @@ -800,8 +800,8 @@ - - + + Returns a random floating point value on the interval between [code]from[/code] and [code]to[/code] (inclusive). [codeblock] @@ -811,8 +811,8 @@ - - + + Returns a normally-distributed pseudo-random floating point value using Box-Muller transform with the specified [code]mean[/code] and a standard [code]deviation[/code]. This is also called Gaussian distribution. @@ -831,8 +831,8 @@ - - + + Returns a random signed 32-bit integer between [code]from[/code] and [code]to[/code] (inclusive). If [code]to[/code] is lesser than [code]from[/code], they are swapped. [codeblock] @@ -849,11 +849,11 @@ - - - - - + + + + + Maps a [code]value[/code] from range [code][istart, istop][/code] to [code][ostart, ostop][/code]. See also [method lerp] and [method inverse_lerp]. If [code]value[/code] is outside [code][istart, istop][/code], then the resulting value will also be outside [code][ostart, ostop][/code]. Use [method clamp] on the result of [method range_lerp] if this is not desired. [codeblock] @@ -870,14 +870,14 @@ - + Create a RID from an int64. This is used mainly from native extensions to build servers. - + Rounds [code]x[/code] to the nearest whole number, with halfway cases rounded away from zero. Supported types: [int], [float], [Vector2], [Vector3], [Vector4]. [codeblock] @@ -891,7 +891,7 @@ - + Rounds [code]x[/code] to the nearest whole number, with halfway cases rounded away from zero. A type-safe version of [method round], specialzied in floats. @@ -899,14 +899,14 @@ - + Rounds [code]x[/code] to the nearest whole number, with halfway cases rounded away from zero. A type-safe version of [method round] that returns integer. - + Sets seed for the random number generator. [codeblock] @@ -917,7 +917,7 @@ - + Returns the sign of [code]x[/code] as same type of [Variant] as [code]x[/code] with each component being -1, 0 and 1 for each negative, zero and positive values respectivelu. Variant types [int], [float] (real), [Vector2], [Vector2i], [Vector3] and [Vector3i] are supported. [codeblock] @@ -931,7 +931,7 @@ - + Returns the sign of [code]x[/code] as a float: -1.0 or 1.0. Returns 0.0 if [code]x[/code] is 0. [codeblock] @@ -943,7 +943,7 @@ - + Returns the sign of [code]x[/code] as an integer: -1 or 1. Returns 0 if [code]x[/code] is 0. [codeblock] @@ -955,7 +955,7 @@ - + Returns the sine of angle [code]angle_rad[/code] in radians. [codeblock] @@ -966,7 +966,7 @@ - + Returns the hyperbolic sine of [code]x[/code]. [codeblock] @@ -977,9 +977,9 @@ - - - + + + Returns the result of smoothly interpolating the value of [code]x[/code] between [code]0[/code] and [code]1[/code], based on the where [code]x[/code] lies with respect to the edges [code]from[/code] and [code]to[/code]. The return value is [code]0[/code] if [code]x <= from[/code], and [code]1[/code] if [code]x >= to[/code]. If [code]x[/code] lies between [code]from[/code] and [code]to[/code], the returned value follows an S-shaped curve that maps [code]x[/code] between [code]0[/code] and [code]1[/code]. @@ -996,8 +996,8 @@ - - + + Snaps float value [code]x[/code] to a given [code]step[/code]. This can also be used to round a floating point number to an arbitrary number of decimals. [codeblock] @@ -1009,7 +1009,7 @@ - + Returns the square root of [code]x[/code], where [code]x[/code] is a non-negative number. [codeblock] @@ -1020,7 +1020,7 @@ - + Returns the position of the first non-zero digit, after the decimal point. Note that the maximum return value is 10, which is a design decision in the implementation. [codeblock] @@ -1041,7 +1041,7 @@ - + Converts a formatted string that was returned by [method var2str] to the original value. [codeblock] @@ -1053,7 +1053,7 @@ - + Returns the tangent of angle [code]angle_rad[/code] in radians. [codeblock] @@ -1063,7 +1063,7 @@ - + Returns the hyperbolic tangent of [code]x[/code]. [codeblock] @@ -1074,7 +1074,7 @@ - + Returns the internal type of the given Variant object, using the [enum Variant.Type] values. [codeblock] @@ -1090,7 +1090,7 @@ - + Encodes a [Variant] value to a byte array, without encoding objects. Deserialization can be done with [method bytes2var]. [b]Note:[/b] If you need object serialization, see [method var2bytes_with_objects]. @@ -1098,14 +1098,14 @@ - + Encodes a [Variant] value to a byte array. Encoding objects is allowed (and can potentially include code). Deserialization can be done with [method bytes2var_with_objects]. - + Converts a Variant [code]variable[/code] to a formatted string that can later be parsed using [method str2var]. [codeblock] @@ -1123,7 +1123,7 @@ - + Returns a weak reference to an object, or [code]null[/code] if the argument is invalid. A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it. @@ -1131,9 +1131,9 @@ - - - + + + Wraps the [Variant] [code]value[/code] between [code]min[/code] and [code]max[/code]. Usable for creating loop-alike behavior or infinite surfaces. @@ -1152,9 +1152,9 @@ - - - + + + Wraps float [code]value[/code] between [code]min[/code] and [code]max[/code]. Usable for creating loop-alike behavior or infinite surfaces. @@ -1176,9 +1176,9 @@ - - - + + + Wraps integer [code]value[/code] between [code]min[/code] and [code]max[/code]. Usable for creating loop-alike behavior or infinite surfaces. diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index db880efaf2..86f0487ea9 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -23,15 +23,15 @@ - + Constructs an [AABB] as a copy of the given [AABB]. - - + + Constructs an [AABB] from a position and size. @@ -46,14 +46,14 @@ - + Returns [code]true[/code] if this [AABB] completely encloses another one. - + Returns a copy of this [AABB] expanded to include a given point. [b]Example:[/b] @@ -81,7 +81,7 @@ - + Gets the position of the 8 endpoints of the [AABB] in space. @@ -124,7 +124,7 @@ - + Returns the support point in a given direction. This is useful for collision detection algorithms. @@ -137,7 +137,7 @@ - + Returns a copy of the [AABB] grown a given amount of units towards all the sides. @@ -156,7 +156,7 @@ - + Returns [code]true[/code] if the [AABB] contains a point. Points on the faces of the AABB are considered included, though float-point precision errors may impact the accuracy of such checks. [b]Note:[/b] This method is not reliable for [AABB] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent [AABB] to check for contained points. @@ -164,50 +164,50 @@ - + Returns the intersection between two [AABB]. An empty AABB (size [code](0, 0, 0)[/code]) is returned on failure. - + Returns [code]true[/code] if the [AABB] overlaps with another. - + Returns [code]true[/code] if the [AABB] is on both sides of a plane. - - + + - - + + Returns [code]true[/code] if the [AABB] intersects the line segment between [code]from[/code] and [code]to[/code]. - + Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [method @GlobalScope.is_equal_approx] on each component. - + Returns a larger [AABB] that contains both this [AABB] and [code]with[/code]. @@ -228,7 +228,7 @@ - + Returns [code]true[/code] if the vectors are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -236,14 +236,14 @@ - + Inversely transforms (multiplies) the [AABB] by the given [Transform3D] transformation matrix. - + Returns [code]true[/code] if the AABBs are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. diff --git a/doc/classes/AESContext.xml b/doc/classes/AESContext.xml index 82634f8859..fe67f7de54 100644 --- a/doc/classes/AESContext.xml +++ b/doc/classes/AESContext.xml @@ -94,16 +94,16 @@ - - - + + + Start the AES context in the given [code]mode[/code]. A [code]key[/code] of either 16 or 32 bytes must always be provided, while an [code]iv[/code] (initialization vector) of exactly 16 bytes, is only needed when [code]mode[/code] is either [constant MODE_CBC_ENCRYPT] or [constant MODE_CBC_DECRYPT]. - + Run the desired operation for this AES context. Will return a [PackedByteArray] containing the result of encrypting (or decrypting) the given [code]src[/code]. See [method start] for mode of operation. [b]Note:[/b] The size of [code]src[/code] must be a multiple of 16. Apply some padding if needed. diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml index c05fb885b9..eed0dd8688 100644 --- a/doc/classes/AStar2D.xml +++ b/doc/classes/AStar2D.xml @@ -11,8 +11,8 @@ - - + + Called when computing the cost between two connected points. Note that this function is hidden in the default [code]AStar2D[/code] class. @@ -20,8 +20,8 @@ - - + + Called when estimating the cost between a point and the path's ending point. Note that this function is hidden in the default [code]AStar2D[/code] class. @@ -29,9 +29,9 @@ - - - + + + Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 0.0 or greater. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path. @@ -50,9 +50,9 @@ - - - + + + Returns whether there is a connection/segment between the given points. If [code]bidirectional[/code] is [code]false[/code], returns whether movement from [code]id[/code] to [code]to_id[/code] is possible through this segment. @@ -65,9 +65,9 @@ - - - + + + Creates a segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is allowed, not the reverse direction. [codeblocks] @@ -88,9 +88,9 @@ - - - + + + Deletes the segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is prevented, and a unidirectional segment possibly remains. @@ -103,8 +103,8 @@ - - + + Returns the ID of the closest point to [code]to_position[/code], optionally taking disabled points into account. Returns [code]-1[/code] if there are no points in the points pool. [b]Note:[/b] If several points are the closest to [code]to_position[/code], the one with the smallest ID will be returned, ensuring a deterministic result. @@ -112,7 +112,7 @@ - + Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points. [codeblocks] @@ -136,8 +136,8 @@ - - + + Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. [codeblocks] @@ -180,7 +180,7 @@ - + Returns an array with the IDs of the points that form the connection with the given point. [codeblocks] @@ -225,8 +225,8 @@ - - + + Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. [b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty [PackedVector2Array] and will print an error message. @@ -234,66 +234,66 @@ - + Returns the position of the point associated with the given [code]id[/code]. - + Returns the weight scale of the point associated with the given [code]id[/code]. - + Returns whether a point associated with the given [code]id[/code] exists. - + Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. - + Removes the point associated with the given [code]id[/code] from the points pool. - + Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity. - - + + Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. - - + + Sets the [code]position[/code] for the point with the given [code]id[/code]. - - + + Sets the [code]weight_scale[/code] for the point with the given [code]id[/code]. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. diff --git a/doc/classes/AStar3D.xml b/doc/classes/AStar3D.xml index ea4e49c173..dc8c62054b 100644 --- a/doc/classes/AStar3D.xml +++ b/doc/classes/AStar3D.xml @@ -40,8 +40,8 @@ - - + + Called when computing the cost between two connected points. Note that this function is hidden in the default [code]AStar3D[/code] class. @@ -49,8 +49,8 @@ - - + + Called when estimating the cost between a point and the path's ending point. Note that this function is hidden in the default [code]AStar3D[/code] class. @@ -58,9 +58,9 @@ - - - + + + Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 0.0 or greater. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path. @@ -79,9 +79,9 @@ - - - + + + Returns whether the two given points are directly connected by a segment. If [code]bidirectional[/code] is [code]false[/code], returns whether movement from [code]id[/code] to [code]to_id[/code] is possible through this segment. @@ -94,9 +94,9 @@ - - - + + + Creates a segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is allowed, not the reverse direction. [codeblocks] @@ -117,9 +117,9 @@ - - - + + + Deletes the segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is prevented, and a unidirectional segment possibly remains. @@ -132,8 +132,8 @@ - - + + Returns the ID of the closest point to [code]to_position[/code], optionally taking disabled points into account. Returns [code]-1[/code] if there are no points in the points pool. [b]Note:[/b] If several points are the closest to [code]to_position[/code], the one with the smallest ID will be returned, ensuring a deterministic result. @@ -141,7 +141,7 @@ - + Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points. [codeblocks] @@ -165,8 +165,8 @@ - - + + Returns an array with the IDs of the points that form the path found by AStar3D between the given points. The array is ordered from the starting point to the ending point of the path. [codeblocks] @@ -208,7 +208,7 @@ - + Returns an array with the IDs of the points that form the connection with the given point. [codeblocks] @@ -252,8 +252,8 @@ - - + + Returns an array with the points that are in the path found by AStar3D between the given points. The array is ordered from the starting point to the ending point of the path. [b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty [PackedVector3Array] and will print an error message. @@ -261,66 +261,66 @@ - + Returns the position of the point associated with the given [code]id[/code]. - + Returns the weight scale of the point associated with the given [code]id[/code]. - + Returns whether a point associated with the given [code]id[/code] exists. - + Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. - + Removes the point associated with the given [code]id[/code] from the points pool. - + Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity. - - + + Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. - - + + Sets the [code]position[/code] for the point with the given [code]id[/code]. - - + + Sets the [code]weight_scale[/code] for the point with the given [code]id[/code]. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index 0009c82548..3dde8664de 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -11,9 +11,9 @@ - - - + + + Adds a button with label [code]text[/code] and a custom [code]action[/code] to the dialog and returns the created button. [code]action[/code] will be passed to the [signal custom_action] signal when pressed. If [code]true[/code], [code]right[/code] will place the button to the right of any sibling buttons. @@ -22,7 +22,7 @@ - + Adds a button with label [code]name[/code] and a cancel action to the dialog and returns the created button. You can use [method remove_button] method to remove a button created with this method from the dialog. @@ -44,14 +44,14 @@ - + Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. - + Removes the [code]button[/code] from the dialog. Does NOT free the [code]button[/code]. The [code]button[/code] must be a [Button] added with [method add_button] or [method add_cancel_button] method. After removal, pressing the [code]button[/code] will no longer emit this dialog's [signal custom_action] or [signal cancelled] signals. @@ -92,7 +92,7 @@ - + Emitted when a custom button is pressed. See [method add_button]. diff --git a/doc/classes/AnimatedSprite2D.xml b/doc/classes/AnimatedSprite2D.xml index 638d142791..39527664ed 100644 --- a/doc/classes/AnimatedSprite2D.xml +++ b/doc/classes/AnimatedSprite2D.xml @@ -14,8 +14,8 @@ - - + + Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. If [code]backwards[/code] is [code]true[/code], the animation will be played in reverse. diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index 30ea2249a3..aa56e50886 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -18,7 +18,7 @@ - + Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. diff --git a/doc/classes/AnimatedTexture.xml b/doc/classes/AnimatedTexture.xml index c322db9c37..5ad4c4e10a 100644 --- a/doc/classes/AnimatedTexture.xml +++ b/doc/classes/AnimatedTexture.xml @@ -14,22 +14,22 @@ - + Returns the given frame's delay value. - + Returns the given frame's [Texture2D]. - - + + Sets an additional delay (in seconds) between this frame and the next one, that will be added to the time interval defined by [member fps]. By default, frames have no delay defined. If a delay value is defined, the final time interval between this frame and the next will be [code]1.0 / fps + delay[/code]. For example, for an animation with 3 frames, 2 FPS and a frame delay on the second frame of 1.2, the resulting playback will be: @@ -43,8 +43,8 @@ - - + + Assigns a [Texture2D] to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID [member frames] - 1. You can define any number of textures up to [constant MAX_FRAMES], but keep in mind that only frames from 0 to [member frames] - 1 will be part of the animation. diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index f40f11944d..5186cb2ea1 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -33,42 +33,42 @@ - - + + Adds a track to the Animation. - - + + Returns the animation name at the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Animation Track. - - - + + + Inserts a key with value [code]animation[/code] at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of an Animation Track. - - - + + + Sets the key identified by [code]key_idx[/code] to value [code]animation[/code]. The [code]track_idx[/code] must be the index of an Animation Track. - - + + Returns the end offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. End offset is the number of seconds cut off at the ending of the audio stream. @@ -76,8 +76,8 @@ - - + + Returns the start offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. Start offset is the number of seconds cut off at the beginning of the audio stream. @@ -85,19 +85,19 @@ - - + + Returns the audio stream of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. - - - - - + + + + + Inserts an Audio Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of an Audio Track. [code]stream[/code] is the [AudioStream] resource to play. [code]start_offset[/code] is the number of seconds cut off at the beginning of the audio stream, while [code]end_offset[/code] is at the ending. @@ -105,71 +105,71 @@ - - - + + + Sets the end offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track. - - - + + + Sets the start offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track. - - - + + + Sets the stream of the key identified by [code]key_idx[/code] to value [code]stream[/code]. The [code]track_idx[/code] must be the index of an Audio Track. - - + + Returns the handle mode of the key identified by [code]index[/code]. See [enum HandleMode] for possible values. The [code]track_idx[/code] must be the index of a Bezier Track. - - + + Returns the in handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. - - + + Returns the out handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. - - + + Returns the value of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. - - - - - - + + + + + + Inserts a Bezier Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of a Bezier Track. [code]in_handle[/code] is the left-side weight of the added Bezier curve point, [code]out_handle[/code] is the right-side one, while [code]value[/code] is the actual value at this point. @@ -177,56 +177,56 @@ - - + + Returns the interpolated value at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of a Bezier Track. - - - - + + + + Changes the handle mode of the keyframe at the given [code]index[/code]. See [enum HandleMode] for possible values. The [code]track_idx[/code] must be the index of a Bezier Track. - - - - + + + + Sets the in handle of the key identified by [code]key_idx[/code] to value [code]in_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. - - - - + + + + Sets the out handle of the key identified by [code]key_idx[/code] to value [code]out_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. - - - + + + Sets the value of the key identified by [code]key_idx[/code] to the given value. The [code]track_idx[/code] must be the index of a Bezier Track. - - - + + + @@ -238,24 +238,24 @@ - - - + + + - - + + Adds a new track that is a copy of the given track from [code]to_animation[/code]. - - + + Returns the index of the specified track. If the track is not found, return -1. @@ -268,259 +268,259 @@ - - - + + + Returns all the key indices of a method track, given a position and delta time. - - + + Returns the method name of a method track. - - + + Returns the arguments values to be called on a method track for a given key in a given track. - - - + + + - + Removes a track by specifying the track index. - - - + + + - - - + + + - - - + + + Finds the key index by time in a given track. Optionally, only find it if the exact time is given. - + Returns [code]true[/code] if the track at [code]idx[/code] wraps the interpolation loop. New tracks wrap the interpolation loop by default. - + Returns the interpolation type of a given track. - + Returns the amount of keys in a given track. - - + + Returns the time at which the key is located. - - + + Returns the transition curve (easing) for a specific key (see the built-in math function [method @GlobalScope.ease]). - - + + Returns the value of a given key in a given track. - + Gets the path of a track. For more information on the path format, see [method track_set_path]. - + Gets the type of a track. - - - - + + + + Inserts a generic key in a given track. Returns the key index. - + - + Returns [code]true[/code] if the track at index [code]idx[/code] is enabled. - + Returns [code]true[/code] if the given track is imported. Else, return [code]false[/code]. - + Moves a track down. - - + + Changes the index position of track [code]idx[/code] to the one defined in [code]to_idx[/code]. - + Moves a track up. - - + + Removes a key by index in a given track. - - + + Removes a key at [code]time[/code] in a given track. - - + + Enables/disables the given track. Tracks are enabled by default. - - + + Sets the given track as imported or not. - - + + If [code]true[/code], the track at [code]idx[/code] wraps the interpolation loop. - - + + Sets the interpolation type of a given track. - - - + + + Sets the time of an existing key. - - - + + + Sets the transition curve (easing) for a specific key (see the built-in math function [method @GlobalScope.ease]). - - - + + + Sets the value of an existing key. - - + + Sets the path of a track. Paths must be valid scene-tree paths to a node and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by [code]":"[/code]. For example, [code]"character/skeleton:ankle"[/code] or [code]"character/mesh:transform/local"[/code]. @@ -528,40 +528,40 @@ - - + + Swaps the track [code]idx[/code]'s index position with the track [code]with_idx[/code]. - - - + + + Returns all the key indices of a value track, given a position and delta time. - + Returns the update mode of a value track. - - + + Returns the interpolated value at the given time (in seconds). The [code]track_idx[/code] must be the index of a value track. - - + + Sets the update mode (see [enum UpdateMode]) of a value track. diff --git a/doc/classes/AnimationLibrary.xml b/doc/classes/AnimationLibrary.xml index d856c65dfc..015d306b41 100644 --- a/doc/classes/AnimationLibrary.xml +++ b/doc/classes/AnimationLibrary.xml @@ -9,14 +9,14 @@ - - + + - + @@ -27,20 +27,20 @@ - + - + - - + + @@ -51,18 +51,18 @@ - + - + - - + + diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index 189e30b5f2..ba20007825 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -19,7 +19,7 @@ - + Gets a child node by index (used by editors inheriting from [AnimationRootNode]). @@ -32,7 +32,7 @@ - + Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. @@ -51,9 +51,9 @@ - - - + + + User-defined callback called when a custom node is processed. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] is [code]true[/code], in which case it is absolute. Here, call the [method blend_input], [method blend_node] or [method blend_animation] functions. You can also use [method get_parameter] and [method set_parameter] to modify local memory. @@ -62,47 +62,47 @@ - + Adds an input to the node. This is only useful for nodes created for use in an [AnimationNodeBlendTree]. - - - - - - - + + + + + + + Blend an animation by [code]blend[/code] amount (name must be valid in the linked [AnimationPlayer]). A [code]time[/code] and [code]delta[/code] may be passed, as well as whether [code]seek[/code] happened. - - - - - - - + + + + + + + Blend an input. This is only useful for nodes created for an [AnimationNodeBlendTree]. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] is [code]true[/code], in which case it is absolute. A filter mode may be optionally passed (see [enum FilterAction] for options). - - - - - - - - + + + + + + + + Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from [AnimationRootNode] instead, else editors will not display your node for addition. @@ -115,44 +115,44 @@ - + Gets the name of an input by index. - + Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. - + Returns whether the given path is filtered. - + Removes an input, call this only when inactive. - - + + Adds or removes a path for the filter. - - + + Sets a custom parameter. These are used as local memory, because resources can be reused across the tree or scenes. diff --git a/doc/classes/AnimationNodeBlendSpace1D.xml b/doc/classes/AnimationNodeBlendSpace1D.xml index 7bb136308d..3279c5465e 100644 --- a/doc/classes/AnimationNodeBlendSpace1D.xml +++ b/doc/classes/AnimationNodeBlendSpace1D.xml @@ -15,9 +15,9 @@ - - - + + + Adds a new point that represents a [code]node[/code] on the virtual axis at a given position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array. @@ -30,37 +30,37 @@ - + Returns the [AnimationNode] referenced by the point at index [code]point[/code]. - + Returns the position of the point at index [code]point[/code]. - + Removes the point at index [code]point[/code] from the blend axis. - - + + Changes the [AnimationNode] referenced by the point at index [code]point[/code]. - - + + Updates the position of the point at index [code]point[/code] on the blend axis. diff --git a/doc/classes/AnimationNodeBlendSpace2D.xml b/doc/classes/AnimationNodeBlendSpace2D.xml index eb2249d2d2..9030634bac 100644 --- a/doc/classes/AnimationNodeBlendSpace2D.xml +++ b/doc/classes/AnimationNodeBlendSpace2D.xml @@ -15,19 +15,19 @@ - - - + + + Adds a new point that represents a [code]node[/code] at the position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array. - - - - + + + + Creates a new triangle using three points [code]x[/code], [code]y[/code], and [code]z[/code]. Triangles can overlap. You can insert the triangle at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array. @@ -40,14 +40,14 @@ - + Returns the [AnimationRootNode] referenced by the point at index [code]point[/code]. - + Returns the position of the point at index [code]point[/code]. @@ -60,38 +60,38 @@ - - + + Returns the position of the point at index [code]point[/code] in the triangle of index [code]triangle[/code]. - + Removes the point at index [code]point[/code] from the blend space. - + Removes the triangle at index [code]triangle[/code] from the blend space. - - + + Changes the [AnimationNode] referenced by the point at index [code]point[/code]. - - + + Updates the position of the point at index [code]point[/code] on the blend axis. diff --git a/doc/classes/AnimationNodeBlendTree.xml b/doc/classes/AnimationNodeBlendTree.xml index fcdd09f144..b4995b90c8 100644 --- a/doc/classes/AnimationNodeBlendTree.xml +++ b/doc/classes/AnimationNodeBlendTree.xml @@ -13,70 +13,70 @@ - - - + + + Adds an [AnimationNode] at the given [code]position[/code]. The [code]name[/code] is used to identify the created sub-node later. - - - + + + Connects the output of an [AnimationNode] as input for another [AnimationNode], at the input port specified by [code]input_index[/code]. - - + + Disconnects the node connected to the specified input. - + Returns the sub-node with the specified [code]name[/code]. - + Returns the position of the sub-node with the specified [code]name[/code]. - + Returns [code]true[/code] if a sub-node with specified [code]name[/code] exists. - + Removes a sub-node. - - + + Changes the name of a sub-node. - - + + Modifies the position of a sub-node. diff --git a/doc/classes/AnimationNodeStateMachine.xml b/doc/classes/AnimationNodeStateMachine.xml index 6140dd799f..1fa05fa8f1 100644 --- a/doc/classes/AnimationNodeStateMachine.xml +++ b/doc/classes/AnimationNodeStateMachine.xml @@ -23,18 +23,18 @@ - - - + + + Adds a new node to the graph. The [code]position[/code] is used for display in the editor. - - - + + + Adds a transition between the given nodes. @@ -47,28 +47,28 @@ - + Returns the animation node with the given name. - + Returns the given animation node's name. - + Returns the given node's coordinates. Used for display in the editor. - + Returns the given transition. @@ -81,81 +81,81 @@ - + Returns the given transition's start node. - + Returns the given transition's end node. - + Returns [code]true[/code] if the graph contains the given node. - - + + Returns [code]true[/code] if there is a transition between the given nodes. - + Deletes the given node from the graph. - - + + Deletes the transition between the two specified nodes. - + Deletes the given transition by index. - - + + Renames the given node. - - + + - + Sets the draw offset of the graph. Used for display in the editor. - - + + Sets the node's coordinates. Used for display in the editor. diff --git a/doc/classes/AnimationNodeStateMachinePlayback.xml b/doc/classes/AnimationNodeStateMachinePlayback.xml index 901ab569c8..8f53ef0dcf 100644 --- a/doc/classes/AnimationNodeStateMachinePlayback.xml +++ b/doc/classes/AnimationNodeStateMachinePlayback.xml @@ -52,7 +52,7 @@ - + Starts playing the given animation. @@ -65,7 +65,7 @@ - + Transitions from the current state to another one, following the shortest path. diff --git a/doc/classes/AnimationNodeTransition.xml b/doc/classes/AnimationNodeTransition.xml index 7e757d4640..a5de170ccd 100644 --- a/doc/classes/AnimationNodeTransition.xml +++ b/doc/classes/AnimationNodeTransition.xml @@ -14,27 +14,27 @@ - + - + - - + + - - + + diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index d3c8bdac3a..7b59051f49 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -17,30 +17,30 @@ - - + + Adds [code]library[/code] to the animation player, under the key [code]name[/code]. - + Shifts position in the animation timeline and immediately updates the animation. [code]delta[/code] is the time in seconds to shift. Events between the current frame and [code]delta[/code] are handled. - + Returns the key of the animation which is queued to play after the [code]anim_from[/code] animation. - - + + Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes. @@ -59,28 +59,28 @@ - + Returns the key of [code]animation[/code] or an empty [StringName] if not found. - + Returns the key for the [AnimationLibrary] that contains [code]animation[/code] or an empty [StringName] if not found. - + Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found. - + Returns the first [AnimationLibrary] with key [code]name[/code] or [code]null[/code] if not found. @@ -99,8 +99,8 @@ - - + + Gets the blend time (in seconds) between two animations, referenced by their keys. @@ -119,14 +119,14 @@ - + Returns [code]true[/code] if the [AnimationPlayer] stores an [Animation] with key [code]name[/code]. - + Returns [code]true[/code] if the [AnimationPlayer] stores an [AnimationLibrary] with key [code]name[/code]. @@ -139,10 +139,10 @@ - - - - + + + + Plays the animation with key [code]name[/code]. Custom blend times and speed can be set. If [code]custom_speed[/code] is negative and [code]from_end[/code] is [code]true[/code], the animation will play backwards (which is equivalent to calling [method play_backwards]). The [AnimationPlayer] keeps track of its current or last played animation with [member assigned_animation]. If this method is called with that same animation [code]name[/code], or with no [code]name[/code] parameter, the assigned animation will resume playing if it was paused, or restart if it was stopped (see [method stop] for both pause and stop). If the animation was already playing, it will keep playing. @@ -151,8 +151,8 @@ - - + + Plays the animation with key [code]name[/code] in reverse. This method is a shorthand for [method play] with [code]custom_speed = -1.0[/code] and [code]from_end = true[/code], so see its description for more information. @@ -160,7 +160,7 @@ - + Queues an animation for playback once the current one is done. [b]Note:[/b] If a looped animation is currently playing, the queued animation will never play unless the looped animation is stopped somehow. @@ -168,23 +168,23 @@ - + Removes the [AnimationLibrary] assosiated with the key [code]name[/code]. - - + + Moves the [AnimationLibrary] associated with the key [code]name[/code] to the key [code]newname[/code]. - - + + Seeks the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time. Events between the current frame and [code]seconds[/code] are skipped. [b]Note:[/b] Seeking to the end of the animation doesn't emit [signal animation_finished]. If you want to skip animation and emit the signal, use [method advance]. @@ -192,16 +192,16 @@ - - - + + + Specifies a blend time (in seconds) between two animations, referenced by their keys. - + Stops or pauses the currently playing animation. If [code]reset[/code] is [code]true[/code], the animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code]. If [code]reset[/code] is [code]false[/code], the [member current_animation_position] will be kept and calling [method play] or [method play_backwards] without arguments or with the same animation name as [member assigned_animation] will resume the animation. @@ -254,22 +254,22 @@ - - + + Emitted when a queued animation plays after the previous animation finished. See [method queue]. [b]Note:[/b] The signal is not emitted when the animation is changed via [method play] or by an [AnimationTree]. - + Notifies when an animation finished playing. [b]Note:[/b] This signal is not emitted if an animation is looping. - + Notifies when an animation starts playing. diff --git a/doc/classes/AnimationTree.xml b/doc/classes/AnimationTree.xml index 45d9152564..f2bf74f495 100644 --- a/doc/classes/AnimationTree.xml +++ b/doc/classes/AnimationTree.xml @@ -14,7 +14,7 @@ - + Manually advance the animations by the specified time (in seconds). @@ -27,8 +27,8 @@ - - + + diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 1eb74768f5..034140ff52 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -29,7 +29,7 @@ - + Returns [code]true[/code] if the given [Area2D] intersects or overlaps this [Area2D], [code]false[/code] otherwise. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, the list of overlaps is updated once per frame and before the physics step. Consider using signals instead. @@ -37,7 +37,7 @@ - + Returns [code]true[/code] if the given physics body intersects or overlaps this [Area2D], [code]false[/code] otherwise. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. @@ -96,24 +96,24 @@ - + Emitted when another Area2D enters this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area2D. - + Emitted when another Area2D exits this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area2D. - - - - + + + + Emitted when one of another Area2D's [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_rid[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. @@ -123,10 +123,10 @@ - - - - + + + + Emitted when one of another Area2D's [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_rid[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. @@ -136,24 +136,24 @@ - + Emitted when a [PhysicsBody2D] or [TileMap] enters this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. - + Emitted when a [PhysicsBody2D] or [TileMap] exits this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. - - - - + + + + Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_rid[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. @@ -163,10 +163,10 @@ - - - - + + + + Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_rid[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. diff --git a/doc/classes/Area3D.xml b/doc/classes/Area3D.xml index 7d14fd825b..0313e8f679 100644 --- a/doc/classes/Area3D.xml +++ b/doc/classes/Area3D.xml @@ -27,7 +27,7 @@ - + Returns [code]true[/code] if the given [Area3D] intersects or overlaps this [Area3D], [code]false[/code] otherwise. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. @@ -35,7 +35,7 @@ - + Returns [code]true[/code] if the given physics body intersects or overlaps this [Area3D], [code]false[/code] otherwise. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. @@ -115,24 +115,24 @@ - + Emitted when another Area3D enters this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area3D. - + Emitted when another Area3D exits this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area3D. - - - - + + + + Emitted when one of another Area3D's [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_rid[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. @@ -142,10 +142,10 @@ - - - - + + + + Emitted when one of another Area3D's [Shape3D]s exits one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_rid[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. @@ -155,24 +155,24 @@ - + Emitted when a [PhysicsBody3D] or [GridMap] enters this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. - + Emitted when a [PhysicsBody3D] or [GridMap] exits this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. - - - - + + + + Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body_rid[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. @@ -182,10 +182,10 @@ - - - - + + + + Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body_rid[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index c149cdc0e4..ac8d09be43 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -53,70 +53,70 @@ - + Constructs an [Array] as a copy of the given [Array]. - + Constructs an array from a [PackedByteArray]. - + Constructs an array from a [PackedColorArray]. - + Constructs an array from a [PackedFloat32Array]. - + Constructs an array from a [PackedFloat64Array]. - + Constructs an array from a [PackedInt32Array]. - + Constructs an array from a [PackedInt64Array]. - + Constructs an array from a [PackedStringArray]. - + Constructs an array from a [PackedVector2Array]. - + Constructs an array from a [PackedVector3Array]. @@ -125,7 +125,7 @@ - + Calls the provided [Callable] on each element in the array and returns [code]true[/code] if the [Callable] returns [code]true[/code] for [i]all[/i] elements in the array. If the [Callable] returns [code]false[/code] for one array element or more, this method returns [code]false[/code]. The callable's method should take one [Variant] parameter (the current array element) and return a boolean value. @@ -148,7 +148,7 @@ - + Calls the provided [Callable] on each element in the array and returns [code]true[/code] if the [Callable] returns [code]true[/code] for [i]one or more[/i] elements in the array. If the [Callable] returns [code]false[/code] for all elements in the array, this method returns [code]false[/code]. The callable's method should take one [Variant] parameter (the current array element) and return a boolean value. @@ -171,14 +171,14 @@ - + Appends an element at the end of the array (alias of [method push_back]). - + Appends another array at the end of this array. [codeblock] @@ -198,8 +198,8 @@ - - + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -207,9 +207,9 @@ - - - + + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return [code]true[/code] if the first argument is less than the second, and return [code]false[/code] otherwise. [b]Note:[/b] Calling [method bsearch_custom] on an unsorted array results in unexpected behavior. @@ -223,14 +223,14 @@ - + Returns the number of times an element is in the array. - + Returns a copy of the array. If [code]deep[/code] is [code]true[/code], a deep copy is performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If [code]false[/code], a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array. @@ -238,7 +238,7 @@ - + Removes the first occurrence of a value from the array. If the value does not exist in the array, nothing happens. To remove an element by index, use [method remove_at] instead. [b]Note:[/b] This method acts in-place and doesn't return a value. @@ -247,7 +247,7 @@ - + Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements: [codeblocks] @@ -266,7 +266,7 @@ - + Calls the provided [Callable] on each element in the array and returns a new array with the elements for which the method returned [code]true[/code]. The callable's method should take one [Variant] parameter (the current array element) and return a boolean value. @@ -283,15 +283,15 @@ - - + + Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. - + Searches the array in reverse order for a value and returns its index or [code]-1[/code] if not found. @@ -305,7 +305,7 @@ - + Returns [code]true[/code] if the array contains the given value. [codeblocks] @@ -352,8 +352,8 @@ - - + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]pos == size()[/code]). [b]Note:[/b] This method acts in-place and doesn't return a value. @@ -368,7 +368,7 @@ - + Calls the provided [Callable] for each element in the array and returns a new array filled with values returned by the method. The callable's method should take one [Variant] parameter (the current array element) and can return any [Variant]. @@ -397,7 +397,7 @@ - + Removes and returns the element of the array at index [code]position[/code]. If negative, [code]position[/code] is considered relative to the end of the array. Leaves the array untouched and returns [code]null[/code] if the array is empty or if it's accessed out of bounds. An error message is printed when the array is accessed out of bounds, but not when the array is empty. [b]Note:[/b] On large arrays, this method can be slower than [method pop_back] as it will reindex the array's elements that are located after the removed element. The larger the array and the lower the index of the removed element, the slower [method pop_at] will be. @@ -418,14 +418,14 @@ - + Appends an element at the end of the array. See also [method push_front]. - + Adds an element at the beginning of the array. See also [method push_back]. [b]Note:[/b] On large arrays, this method is much slower than [method push_back] as it will reindex all the array's elements every time it's called. The larger the array, the slower [method push_front] will be. @@ -433,8 +433,8 @@ - - + + Calls the provided [Callable] for each element in array and accumulates the result in [code]accum[/code]. The callable's method takes two arguments: the current value of [code]accum[/code] and the current array element. If [code]accum[/code] is [code]null[/code] (default value), the iteration will start from the second element, with the first one used as initial value of [code]accum[/code]. @@ -451,7 +451,7 @@ - + Removes an element from the array by index. If the index does not exist in the array, nothing happens. To remove an element by searching for its value, use [method erase] instead. [b]Note:[/b] This method acts in-place and doesn't return a value. @@ -460,7 +460,7 @@ - + Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are [code]null[/code]. @@ -473,8 +473,8 @@ - - + + Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -493,10 +493,10 @@ - - - - + + + + Returns the slice of the [Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -530,7 +530,7 @@ - + Sorts the array using a custom method. The custom method receives two arguments (a pair of elements from the array) and must return either [code]true[/code] or [code]false[/code]. For two elements [code]a[/code] and [code]b[/code], if the given method returns [code]true[/code], element [code]b[/code] will be after element [code]a[/code] in the array. [b]Note:[/b] You cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. @@ -560,56 +560,56 @@ - + Compares the left operand [Array] against the [code]right[/code] [Array]. Returns [code]true[/code] if the sizes or contents of the arrays are [i]not[/i] equal, [code]false[/code] otherwise. - + Concatenates two [Array]s together, with the [code]right[/code] [Array] being added to the end of the [Array] specified in the left operand. For example, [code][1, 2] + [3, 4][/code] results in [code][1, 2, 3, 4][/code]. - + Performs a comparison for each index between the left operand [Array] and the [code]right[/code] [Array], considering the highest common index of both arrays for this comparison: Returns [code]true[/code] on the first occurrence of an element that is less, or [code]false[/code] if the element is greater. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns [code]false[/code] if the left operand [Array] has less elements, otherwise it returns [code]true[/code]. - + Performs a comparison for each index between the left operand [Array] and the [code]right[/code] [Array], considering the highest common index of both arrays for this comparison: Returns [code]true[/code] on the first occurrence of an element that is less, or [code]false[/code] if the element is greater. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns [code]true[/code] if the left operand [Array] has less or the same number of elements, otherwise it returns [code]false[/code]. - + Compares the left operand [Array] against the [code]right[/code] [Array]. Returns [code]true[/code] if the sizes and contents of the arrays are equal, [code]false[/code] otherwise. - + Performs a comparison for each index between the left operand [Array] and the [code]right[/code] [Array], considering the highest common index of both arrays for this comparison: Returns [code]true[/code] on the first occurrence of an element that is greater, or [code]false[/code] if the element is less. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns [code]true[/code] if the [code]right[/code] [Array] has more elements, otherwise it returns [code]false[/code]. - + Performs a comparison for each index between the left operand [Array] and the [code]right[/code] [Array], considering the highest common index of both arrays for this comparison: Returns [code]true[/code] on the first occurrence of an element that is greater, or [code]false[/code] if the element is less. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns [code]true[/code] if the [code]right[/code] [Array] has more or the same number of elements, otherwise it returns [code]false[/code]. - + Returns a reference to the element of type [Variant] at the specified location. Arrays start at index 0. [code]index[/code] can be a zero or positive value to start from the beginning, or a negative value to start from the end. Out-of-bounds array access causes a run-time error, which will result in an error being printed and the project execution pausing if run from the editor. diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index f5c799d4de..500cf342c0 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -52,18 +52,18 @@ - + Adds name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added. - - - - - + + + + + Creates a new surface. Surfaces are created to be rendered using a [code]primitive[/code], which may be any of the types defined in [enum Mesh.PrimitiveType]. (As a note, when using indices, it is recommended to only use points, lines, or triangles.) [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface. @@ -90,15 +90,15 @@ - + Returns the name of the blend shape at this index. - - + + Will perform a UV unwrap on the [ArrayMesh] to prepare the mesh for lightmapping. @@ -111,83 +111,83 @@ - - + + Sets the name of the blend shape at this index. - + Returns the index of the first surface with this name held within this [ArrayMesh]. If none are found, -1 is returned. - + Returns the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]). - + Returns the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]). - + Returns the format mask of the requested surface (see [method add_surface_from_arrays]). - + Gets the name assigned to this surface. - + Returns the primitive type of the requested surface (see [method add_surface_from_arrays]). - - + + Sets a name for a given surface. - - - + + + - - - + + + - - - + + + diff --git a/doc/classes/ArrayOccluder3D.xml b/doc/classes/ArrayOccluder3D.xml index 7f6bf93c8f..866427beeb 100644 --- a/doc/classes/ArrayOccluder3D.xml +++ b/doc/classes/ArrayOccluder3D.xml @@ -12,8 +12,8 @@ - - + + diff --git a/doc/classes/AudioEffectCapture.xml b/doc/classes/AudioEffectCapture.xml index 8e02056456..016c71bf27 100644 --- a/doc/classes/AudioEffectCapture.xml +++ b/doc/classes/AudioEffectCapture.xml @@ -13,7 +13,7 @@ - + Returns [code]true[/code] if at least [code]frames[/code] audio frames are available to read in the internal ring buffer. @@ -26,7 +26,7 @@ - + Gets the next [code]frames[/code] audio samples from the internal ring buffer. Returns a [PackedVector2Array] containing exactly [code]frames[/code] audio samples if available, or an empty [PackedVector2Array] if insufficient data was available. diff --git a/doc/classes/AudioEffectChorus.xml b/doc/classes/AudioEffectChorus.xml index 5efba17e6a..83cbcff70c 100644 --- a/doc/classes/AudioEffectChorus.xml +++ b/doc/classes/AudioEffectChorus.xml @@ -12,79 +12,79 @@ - + - + - + - + - + - + - - + + - - + + - - + + - - + + - - + + - - + + diff --git a/doc/classes/AudioEffectEQ.xml b/doc/classes/AudioEffectEQ.xml index ce5b6de3be..6e4040c16e 100644 --- a/doc/classes/AudioEffectEQ.xml +++ b/doc/classes/AudioEffectEQ.xml @@ -19,15 +19,15 @@ - + Returns the band's gain at the specified index, in dB. - - + + Sets band's gain at the specified index, in dB. diff --git a/doc/classes/AudioEffectInstance.xml b/doc/classes/AudioEffectInstance.xml index f50246d6ca..bc3d579f36 100644 --- a/doc/classes/AudioEffectInstance.xml +++ b/doc/classes/AudioEffectInstance.xml @@ -9,9 +9,9 @@ - - - + + + diff --git a/doc/classes/AudioEffectRecord.xml b/doc/classes/AudioEffectRecord.xml index 32a6aea340..ff034389fc 100644 --- a/doc/classes/AudioEffectRecord.xml +++ b/doc/classes/AudioEffectRecord.xml @@ -27,7 +27,7 @@ - + If [code]true[/code], the sound will be recorded. Note that restarting the recording will remove the previously recorded sample. diff --git a/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml b/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml index 08dd5a5d69..55ac78f197 100644 --- a/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml +++ b/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml @@ -9,9 +9,9 @@ - - - + + + diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 28dcd2794e..98b28ae504 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -15,16 +15,16 @@ - + Adds a bus at [code]at_position[/code]. - - - + + + Adds an [AudioEffect] effect to the bus [code]bus_idx[/code] at [code]at_position[/code]. @@ -43,75 +43,75 @@ - + Returns the amount of channels of the bus at index [code]bus_idx[/code]. - - + + Returns the [AudioEffect] at position [code]effect_idx[/code] in bus [code]bus_idx[/code]. - + Returns the number of effects on the bus at [code]bus_idx[/code]. - - - + + + Returns the [AudioEffectInstance] assigned to the given bus and effect indices (and optionally channel). - + Returns the index of the bus with the name [code]bus_name[/code]. - + Returns the name of the bus with the index [code]bus_idx[/code]. - - + + Returns the peak volume of the left speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code]. - - + + Returns the peak volume of the right speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code]. - + Returns the name of the bus that the bus at index [code]bus_idx[/code] sends to. - + Returns the volume of the bus at index [code]bus_idx[/code] in dB. @@ -154,29 +154,29 @@ - + If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects. - - + + If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled. - + If [code]true[/code], the bus at index [code]bus_idx[/code] is muted. - + If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode. @@ -190,102 +190,102 @@ - - + + Moves the bus from index [code]index[/code] to index [code]to_index[/code]. - + Removes the bus at index [code]index[/code]. - - + + Removes the effect at index [code]effect_idx[/code] from the bus at index [code]bus_idx[/code]. - - + + If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects. - - - + + + If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled. - + Overwrites the currently used [AudioBusLayout]. - - + + If [code]true[/code], the bus at index [code]bus_idx[/code] is muted. - - + + Sets the name of the bus at index [code]bus_idx[/code] to [code]name[/code]. - - + + Connects the output of the bus at [code]bus_idx[/code] to the bus named [code]send[/code]. - - + + If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode. - - + + Sets the volume of the bus at index [code]bus_idx[/code] to [code]volume_db[/code]. - + - - - + + + Swaps the position of two effects in bus [code]bus_idx[/code]. diff --git a/doc/classes/AudioStreamGeneratorPlayback.xml b/doc/classes/AudioStreamGeneratorPlayback.xml index 06c285bff7..8bc8e61869 100644 --- a/doc/classes/AudioStreamGeneratorPlayback.xml +++ b/doc/classes/AudioStreamGeneratorPlayback.xml @@ -13,7 +13,7 @@ - + Returns [code]true[/code] if a buffer of the size [code]amount[/code] can be pushed to the audio sample data buffer without overflowing it, [code]false[/code] otherwise. @@ -37,14 +37,14 @@ - + Pushes several audio data frames to the buffer. This is usually more efficient than [method push_frame] in C# and compiled languages via GDExtension, but [method push_buffer] may be [i]less[/i] efficient in GDScript. - + Pushes a single audio data frame to the buffer. This is usually less efficient than [method push_buffer] in C# and compiled languages via GDExtension, but [method push_frame] may be [i]more[/i] efficient in GDScript. diff --git a/doc/classes/AudioStreamPlayback.xml b/doc/classes/AudioStreamPlayback.xml index f1a1c18c1c..e80c112f16 100644 --- a/doc/classes/AudioStreamPlayback.xml +++ b/doc/classes/AudioStreamPlayback.xml @@ -27,21 +27,21 @@ - - - + + + - + - + diff --git a/doc/classes/AudioStreamPlaybackResampled.xml b/doc/classes/AudioStreamPlaybackResampled.xml index eb41e4256e..cc2268f145 100644 --- a/doc/classes/AudioStreamPlaybackResampled.xml +++ b/doc/classes/AudioStreamPlaybackResampled.xml @@ -14,8 +14,8 @@ - - + + diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index e0bc98e208..29dbb1c1c9 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -30,14 +30,14 @@ - + Plays the audio from the given [code]from_position[/code], in seconds. - + Sets the position from which audio will be played, in seconds. diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index f04f95bd72..4c3e675c41 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -26,14 +26,14 @@ - + Plays the audio from the given position [code]from_position[/code], in seconds. - + Sets the position from which audio will be played, in seconds. diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 72febf7006..9b86a93e74 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -27,14 +27,14 @@ - + Plays the audio from the given position [code]from_position[/code], in seconds. - + Sets the position from which audio will be played, in seconds. diff --git a/doc/classes/AudioStreamRandomizer.xml b/doc/classes/AudioStreamRandomizer.xml index 0eb733582a..5490770b7d 100644 --- a/doc/classes/AudioStreamRandomizer.xml +++ b/doc/classes/AudioStreamRandomizer.xml @@ -11,52 +11,52 @@ - + Insert a stream at the specified index. - + Returns the stream at the specified index. - + Returns the probability weight associated with the stream at the given index. - - + + Move a stream from one index to another. - + Remove the stream at the specified index. - - + + Set the AudioStream at the specified index. - - + + Set the probability weight of the stream at the specified index. The higher this value, the more likely that the randomizer will choose this stream during random playback modes. diff --git a/doc/classes/AudioStreamWAV.xml b/doc/classes/AudioStreamWAV.xml index 17595aec2f..1055fe053e 100644 --- a/doc/classes/AudioStreamWAV.xml +++ b/doc/classes/AudioStreamWAV.xml @@ -12,7 +12,7 @@ - + Saves the AudioStreamWAV as a WAV file to [code]path[/code]. Samples with IMA ADPCM format can't be saved. [b]Note:[/b] A [code].wav[/code] extension is automatically appended to [code]path[/code] if it is missing. diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 13fe75a3e3..0d934f861d 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -17,7 +17,7 @@ - + Called when the button is toggled (only if [member toggle_mode] is active). @@ -36,7 +36,7 @@ - + Changes the [member button_pressed] state of the button, without emitting [signal toggled]. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if [member toggle_mode] is [code]true[/code]. [b]Note:[/b] This method doesn't unpress other buttons in [member button_group]. @@ -96,7 +96,7 @@ - + Emitted when the button was just toggled between pressed and normal states (only if [member toggle_mode] is active). The new state is contained in the [code]button_pressed[/code] argument. diff --git a/doc/classes/BaseMaterial3D.xml b/doc/classes/BaseMaterial3D.xml index d0290ff5fd..93818e6cfc 100644 --- a/doc/classes/BaseMaterial3D.xml +++ b/doc/classes/BaseMaterial3D.xml @@ -12,45 +12,45 @@ - + Returns [code]true[/code], if the specified [enum Feature] is enabled. - + Returns [code]true[/code], if the specified flag is enabled. See [enum Flags] enumerator for options. - + Returns the [Texture] associated with the specified [enum TextureParam]. - - + + If [code]true[/code], enables the specified [enum Feature]. Many features that are available in [BaseMaterial3D]s need to be enabled before use. This way the cost for using the feature is only incurred when specified. Features can also be enabled by setting the corresponding member to [code]true[/code]. - - + + If [code]true[/code], enables the specified flag. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to [code]true[/code]. See [enum Flags] enumerator for options. - - + + Sets the texture for the slot specified by [code]param[/code]. See [enum TextureParam] for available slots. diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 0af482d654..36242a4402 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -27,31 +27,31 @@ - + Constructs a [Basis] as a copy of the given [Basis]. - - + + Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]angle[/code] (in radians). The axis must be a normalized vector. - + Constructs a pure rotation basis matrix from the given quaternion. - - - + + + Constructs a basis matrix from 3 axis vectors (matrix columns). @@ -67,21 +67,21 @@ - - + + - + Constructs a pure scale basis matrix with no rotation or shearing. The scale values are set as the diagonal of the matrix, and the other parts of the matrix are zero. - + Returns the basis's rotation in the form of Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last). The returned vector contains the rotation angles in the format (X angle, Y angle, Z angle). Consider using the [method get_rotation_quaternion] method instead, which returns a [Quaternion] quaternion instead of Euler angles. @@ -113,15 +113,15 @@ - + Returns [code]true[/code] if this basis and [code]b[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. - - + + Creates a Basis with a rotation such that the forward axis (-Z) points towards the [code]target[/code] position. The up axis (+Y) points as close to the [code]up[/code] vector as possible while staying perpendicular to the forward axis. The resulting Basis is orthonormalized. The [code]target[/code] and [code]up[/code] vectors cannot be zero, and cannot be parallel to each other. @@ -135,44 +135,44 @@ - - + + Introduce an additional rotation around the given axis by [code]angle[/code] (in radians). The axis must be a normalized vector. - + Introduce an additional scaling specified by the given 3D scaling factor. - - + + Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix. - + Transposed dot product with the X axis of the matrix. - + Transposed dot product with the Y axis of the matrix. - + Transposed dot product with the Z axis of the matrix. @@ -225,7 +225,7 @@ - + Returns [code]true[/code] if the [Basis] matrices are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -233,35 +233,35 @@ - + Composes these two basis matrices by multiplying them together. This has the effect of transforming the second basis (the child) by the first basis (the parent). - + Transforms (multiplies) the [Vector3] by the given [Basis] matrix. - + This operator multiplies all components of the [Basis], which scales it uniformly. - + This operator multiplies all components of the [Basis], which scales it uniformly. - + Returns [code]true[/code] if the [Basis] matrices are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -269,7 +269,7 @@ - + Access basis components using their index. [code]b[0][/code] is equivalent to [code]b.x[/code], [code]b[1][/code] is equivalent to [code]b.y[/code], and [code]b[2][/code] is equivalent to [code]b.z[/code]. diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index f248bec15f..402fc18373 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -17,22 +17,22 @@ - + Creates a bitmap with the specified size, filled with [code]false[/code]. - - + + Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to [code]false[/code] if the alpha value of the image at that position is equal to [code]threshold[/code] or less, and [code]true[/code] in other case. - + Returns bitmap's value at the specified position. @@ -51,16 +51,16 @@ - - + + Applies morphological dilation or erosion to the bitmap. If [code]pixels[/code] is positive, dilation is applied to the bitmap. If [code]pixels[/code] is negative, erosion is applied to the bitmap. [code]rect[/code] defines the area where the morphological operation is applied. Pixels located outside the [code]rect[/code] are unaffected by [method grow_mask]. - - + + Creates an [Array] of polygons covering a rectangular portion of the bitmap. It uses a marching squares algorithm, followed by Ramer-Douglas-Peucker (RDP) reduction of the number of vertices. Each polygon is described as a [PackedVector2Array] of its vertices. To get polygons covering the whole bitmap, pass: @@ -72,23 +72,23 @@ - + Resizes the image to [code]new_size[/code]. - - + + Sets the bitmap's element at the specified position, to the specified value. - - + + Sets a rectangular portion of the bitmap to the specified value. diff --git a/doc/classes/Bone2D.xml b/doc/classes/Bone2D.xml index 1e09e90d4a..d452edd1aa 100644 --- a/doc/classes/Bone2D.xml +++ b/doc/classes/Bone2D.xml @@ -57,14 +57,14 @@ - + When set to [code]true[/code], the [code]Bone2D[/code] node will attempt to automatically calculate the bone angle and length using the first child [code]Bone2D[/code] node, if one exists. If none exist, the [code]Bone2D[/code] cannot automatically calculate these values and will print a warning. - + Sets the bone angle for the [code]Bone2D[/code] node. This is typically set to the rotation from the [code]Bone2D[/code] node to a child [code]Bone2D[/code] node. [b]Note:[/b] This is different from the [code]Bone2D[/code]'s rotation. The bone angle is the rotation of the bone shown by the [code]Bone2D[/code] gizmo, and because [code]Bone2D[/code] bones are based on positions, this can vary from the actual rotation of the [code]Bone2D[/code] node. @@ -72,14 +72,14 @@ - + Deprecated. Please use [code]set_length[/code] instead. - + Sets the length of the bone in the [code]Bone2D[/code] node. diff --git a/doc/classes/BoneAttachment3D.xml b/doc/classes/BoneAttachment3D.xml index bb4b45cd48..dc3d448621 100644 --- a/doc/classes/BoneAttachment3D.xml +++ b/doc/classes/BoneAttachment3D.xml @@ -36,35 +36,35 @@ - + A function that is called automatically when the [Skeleton3D] the BoneAttachment3D node is using has a bone that has changed its pose. This function is where the BoneAttachment3D node updates its position so it is correctly bound when it is [i]not[/i] set to override the bone pose. - + Sets the [NodePath] to the external skeleton that the BoneAttachment3D node should use. The external [Skeleton3D] node is only used when [code]use_external_skeleton[/code] is set to [code]true[/code]. - + Sets the override mode for the BoneAttachment3D node. The override mode defines which of the bone poses the BoneAttachment3D node will override. - + Sets whether the BoneAttachment3D node will override the bone pose of the bone it is attached to. When set to [code]true[/code], the BoneAttachment3D node can change the pose of the bone. - + Sets whether the BoneAttachment3D node will use an extenral [Skeleton3D] node rather than attenpting to use its parent node as the [Skeleton3D]. When set to [code]true[/code], the BoneAttachment3D node will use the external [Skeleton3D] node set in [code]set_external_skeleton[/code]. diff --git a/doc/classes/BoneMap.xml b/doc/classes/BoneMap.xml index 371cb4fa93..e9142e2c4b 100644 --- a/doc/classes/BoneMap.xml +++ b/doc/classes/BoneMap.xml @@ -12,7 +12,7 @@ - + Returns a profile bone name having [code]skeleton_bone_name[/code]. If not found, an empty [StringName] will be returned. In the retargeting process, the returned bone name is the bone name of the target skeleton. @@ -20,7 +20,7 @@ - + Returns a skeleton bone name is mapped to [code]profile_bone_name[/code]. In the retargeting process, the returned bone name is the bone name of the source skeleton. @@ -28,8 +28,8 @@ - - + + Maps a skeleton bone name to [code]profile_bone_name[/code]. In the retargeting process, the setting bone name is the bone name of the source skeleton. diff --git a/doc/classes/BoxContainer.xml b/doc/classes/BoxContainer.xml index c76a178368..d7eac40505 100644 --- a/doc/classes/BoxContainer.xml +++ b/doc/classes/BoxContainer.xml @@ -12,7 +12,7 @@ - + Adds a [Control] node to the box as a spacer. If [code]begin[/code] is [code]true[/code], it will insert the [Control] node in front of all other children. diff --git a/doc/classes/ButtonGroup.xml b/doc/classes/ButtonGroup.xml index a887404932..8bedb5a1ac 100644 --- a/doc/classes/ButtonGroup.xml +++ b/doc/classes/ButtonGroup.xml @@ -28,7 +28,7 @@ - + Emitted when one of the buttons of the group is pressed. diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index b0282e4107..64e9310181 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -13,33 +13,33 @@ - + Sets this node's properties to match a given [GPUParticles2D] node with an assigned [ParticlesMaterial]. - + Returns the [Curve] of the parameter specified by [enum Parameter]. - + - + - + Returns the enabled state of the given flag (see [enum ParticleFlags] for options). @@ -52,30 +52,30 @@ - - + + Sets the [Curve] of the parameter specified by [enum Parameter]. - - + + - - + + - - + + Enables or disables the given flag (see [enum ParticleFlags] for options). diff --git a/doc/classes/CPUParticles3D.xml b/doc/classes/CPUParticles3D.xml index d8faf8e91d..bb1dcd322f 100644 --- a/doc/classes/CPUParticles3D.xml +++ b/doc/classes/CPUParticles3D.xml @@ -12,33 +12,33 @@ - + Sets this node's properties to match a given [GPUParticles3D] node with an assigned [ParticlesMaterial]. - + Returns the [Curve] of the parameter specified by [enum Parameter]. - + - + - + Returns the enabled state of the given particle flag (see [enum ParticleFlags] for options). @@ -51,32 +51,32 @@ - - + + Sets the [Curve] of the parameter specified by [enum Parameter]. - - + + Sets the maximum value for the given parameter - - + + Sets the minimum value for the given parameter - - + + Enables or disables the given particle flag (see [enum ParticleFlags] for options). diff --git a/doc/classes/Callable.xml b/doc/classes/Callable.xml index efe3e3d091..48c1b30d8e 100644 --- a/doc/classes/Callable.xml +++ b/doc/classes/Callable.xml @@ -44,15 +44,15 @@ - + Constructs a [Callable] as a copy of the given [Callable]. - - + + Creates a new [Callable] for the method called [code]method[/code] in the specified [code]object[/code]. @@ -134,14 +134,14 @@ - + Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer documentation for reference). This is used for multiplayer and is normally not available unless the function being called has been marked as [i]RPC[/i]. Calling it on unsupported functions will result in an error. - + Returns a copy of this [Callable] with the arguments unbound. Calling the returned [Callable] will call the method without the extra arguments that are supplied in the [Callable] on which you are calling this method. @@ -150,14 +150,14 @@ - + Returns [code]true[/code] if both [Callable]s invoke different targets. - + Returns [code]true[/code] if both [Callable]s invoke the same custom target. diff --git a/doc/classes/CallbackTweener.xml b/doc/classes/CallbackTweener.xml index 3d80d8f3ab..6e4ee0380e 100644 --- a/doc/classes/CallbackTweener.xml +++ b/doc/classes/CallbackTweener.xml @@ -12,7 +12,7 @@ - + Makes the callback call delayed by given time in seconds. Example: [codeblock] diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index b9373676e2..edb5235b75 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -43,14 +43,14 @@ - + Returns the specified [enum Side]'s margin. See also [member drag_bottom_margin], [member drag_top_margin], [member drag_left_margin], and [member drag_right_margin]. - + Returns the camera limit for the specified [enum Side]. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right]. @@ -64,16 +64,16 @@ - - + + Sets the specified [enum Side]'s margin. See also [member drag_bottom_margin], [member drag_top_margin], [member drag_left_margin], and [member drag_right_margin]. - - + + Sets the camera limit for the specified [enum Side]. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right]. diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml index 643351efc0..71d16b5791 100644 --- a/doc/classes/Camera3D.xml +++ b/doc/classes/Camera3D.xml @@ -12,7 +12,7 @@ - + If this is the current camera, remove it from being current. If [code]enable_next[/code] is [code]true[/code], request to make the next camera current, if any. @@ -31,7 +31,7 @@ - + Returns whether or not the specified layer of the [member cull_mask] is enabled, given a [code]layer_number[/code] between 1 and 20. @@ -50,7 +50,7 @@ - + Returns [code]true[/code] if the given position is behind the camera (the blue part of the linked diagram). [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See this diagram[/url] for an overview of position query methods. [b]Note:[/b] A position which returns [code]false[/code] may still be outside the camera's field of view. @@ -58,7 +58,7 @@ - + Returns [code]true[/code] if the given position is inside the camera's frustum (the green part of the linked diagram). [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See this diagram[/url] for an overview of position query methods. @@ -71,72 +71,72 @@ - + Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc. - - + + Returns the 3D point in world space that maps to the given 2D coordinate in the [Viewport] rectangle on a plane that is the given [code]z_depth[/code] distance into the scene away from the camera. - + Returns a normal vector in world space, that is the result of projecting a point on the [Viewport] rectangle by the inverse camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. - + Returns a 3D position in world space, that is the result of projecting a point on the [Viewport] rectangle by the inverse camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member cull_mask], given a [code]layer_number[/code] between 1 and 20. - - - - + + + + Sets the camera projection to frustum mode (see [constant PROJECTION_FRUSTUM]), by specifying a [code]size[/code], an [code]offset[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. See also [member frustum_offset]. - - - + + + Sets the camera projection to orthogonal mode (see [constant PROJECTION_ORTHOGONAL]), by specifying a [code]size[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. (As a hint, 2D games often use this projection, with values specified in pixels.) - - - + + + Sets the camera projection to perspective mode (see [constant PROJECTION_PERSPECTIVE]), by specifying a [code]fov[/code] (field of view) angle in degrees, and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. - + Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in world space. [b]Note:[/b] When using this to position GUI elements over a 3D viewport, use [method is_position_behind] to prevent them from appearing if the 3D point is behind the camera: diff --git a/doc/classes/CameraServer.xml b/doc/classes/CameraServer.xml index 1ccdee58f7..7ec49c7df4 100644 --- a/doc/classes/CameraServer.xml +++ b/doc/classes/CameraServer.xml @@ -13,7 +13,7 @@ - + Adds the camera [code]feed[/code] to the camera server. @@ -26,7 +26,7 @@ - + Returns the [CameraFeed] corresponding to the camera with the given [code]index[/code]. @@ -39,7 +39,7 @@ - + Removes the specified camera [code]feed[/code]. @@ -47,13 +47,13 @@ - + Emitted when a [CameraFeed] is added (e.g. a webcam is plugged in). - + Emitted when a [CameraFeed] is removed (e.g. a webcam is unplugged). diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 2d68ae6902..391ff1efb1 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -25,77 +25,77 @@ - - - - + + + + Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly. - - - - - - - - + + + + + + + + Draws a unfilled arc between the given angles. The larger the value of [code]point_count[/code], the smoother the curve. See also [method draw_circle]. - - - - - + + + + + Draws a string first character using a custom font. - - - - - - + + + + + + Draws a string first character outline using a custom font. - - - + + + Draws a colored, filled circle. See also [method draw_arc], [method draw_polyline] and [method draw_polygon]. - - - - + + + + Draws a colored polygon of any amount of points, convex or concave. Unlike [method draw_polygon], a single color must be specified for the whole polygon. - - - - - + + + + + Draws a dashed line from a 2D point to another, with a given color and width. See also [method draw_multiline] and [method draw_polyline]. @@ -108,33 +108,33 @@ - - - - - + + + + + Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. See also [method draw_multiline] and [method draw_polyline]. - - - - + + + + Draws a [Mesh] in 2D, using the provided texture. See [MeshInstance2D] for related documentation. - - - - - - + + + + + + Draws a textured rectangle region of the multi-channel signed distance field texture at a given position, optionally modulated by a color. See [member FontFile.multichannel_signed_distance_field] for more information and caveats about MSDF font rendering. If [code]outline[/code] is positive, each alpha channel value of pixel in region is set to maximum value of true distance in the [code]outline[/code] radius. @@ -143,114 +143,114 @@ - - - + + + Draws multiple disconnected lines with a uniform [code]color[/code]. When drawing large amounts of lines, this is faster than using individual [method draw_line] calls. To draw interconnected lines, use [method draw_polyline] instead. - - - + + + Draws multiple disconnected lines with a uniform [code]width[/code] and segment-by-segment coloring. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. When drawing large amounts of lines, this is faster than using individual [method draw_line] calls. To draw interconnected lines, use [method draw_polyline_colors] instead. - - - - - - - - - - - - + + + + + + + + + + + + Breaks [code]text[/code] to the lines and draws it using the specified [code]font[/code] at the [code]position[/code] (top-left corner). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. - - - - - - - - - - - - - + + + + + + + + + + + + + Breaks [code]text[/code] to the lines and draws text outline using the specified [code]font[/code] at the [code]position[/code] (top-left corner). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. - - + + Draws a [MultiMesh] in 2D with the provided texture. See [MultiMeshInstance2D] for related documentation. - - - - + + + + Draws a solid polygon of any amount of points, convex or concave. Unlike [method draw_colored_polygon], each point's color can be changed individually. See also [method draw_polyline] and [method draw_polyline_colors]. - - - - + + + + Draws interconnected line segments with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing. When drawing large amounts of lines, this is faster than using individual [method draw_line] calls. To draw disconnected lines, use [method draw_multiline] instead. See also [method draw_polygon]. - - - - + + + + Draws interconnected line segments with a uniform [code]width[/code] and segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. When drawing large amounts of lines, this is faster than using individual [method draw_line] calls. To draw disconnected lines, use [method draw_multiline_colors] instead. See also [method draw_polygon]. - - - - - + + + + + Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle, and 4 points for a quad. If 0 points or more than 4 points are specified, nothing will be drawn and an error message will be printed. See also [method draw_line], [method draw_polyline], [method draw_polygon], and [method draw_rect]. - - - - + + + + Draws a rectangle. If [code]filled[/code] is [code]true[/code], the rectangle will be filled with the [code]color[/code] specified. If [code]filled[/code] is [code]false[/code], the rectangle will be drawn as a stroke with the [code]color[/code] and [code]width[/code] specified. [b]Note:[/b] [code]width[/code] is only effective if [code]filled[/code] is [code]false[/code]. @@ -258,32 +258,32 @@ - - - + + + Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. - + Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. - - - - - - - - - - + + + + + + + + + + Draws [code]text[/code] using the specified [code]font[/code] at the [code]position[/code] (bottom-left corner using the baseline of the font). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. [b]Example using the default project font:[/b] @@ -310,57 +310,57 @@ - - - - - - - - - - - + + + + + + + + + + + Draws [code]text[/code] outline using the specified [code]font[/code] at the [code]position[/code] (bottom-left corner using the baseline of the font). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. - - + + Draws a styled rectangle. - - - + + + Draws a texture at a given position. - - - - - + + + + + Draws a textured rectangle at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped. - - - - - - + + + + + + Draws a textured rectangle region at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped. @@ -470,28 +470,28 @@ - + Assigns [code]screen_point[/code] as this node's new local transform. - + Transformations issued by [code]event[/code]'s inputs are applied in local space instead of global space. - + If [code]enable[/code] is [code]true[/code], this node will receive [constant NOTIFICATION_LOCAL_TRANSFORM_CHANGED] when its local transform changes. - + If [code]enable[/code] is [code]true[/code], this node will receive [constant NOTIFICATION_TRANSFORM_CHANGED] when its global transform changes. diff --git a/doc/classes/CharacterBody2D.xml b/doc/classes/CharacterBody2D.xml index 63d493248f..4a95e18575 100644 --- a/doc/classes/CharacterBody2D.xml +++ b/doc/classes/CharacterBody2D.xml @@ -17,7 +17,7 @@ - + Returns the floor's collision angle at the last collision point according to [code]up_direction[/code], which is [code]Vector2.UP[/code] by default. This value is always positive and only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code]. @@ -60,7 +60,7 @@ - + Returns a [KinematicCollision2D], which contains information about a collision that occurred during the last call to [method move_and_slide]. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_collision_count] - 1). [b]Example usage:[/b] diff --git a/doc/classes/CharacterBody3D.xml b/doc/classes/CharacterBody3D.xml index 795bd7a429..73f4e1c82e 100644 --- a/doc/classes/CharacterBody3D.xml +++ b/doc/classes/CharacterBody3D.xml @@ -18,7 +18,7 @@ - + Returns the floor's collision angle at the last collision point according to [code]up_direction[/code], which is [code]Vector3.UP[/code] by default. This value is always positive and only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code]. @@ -61,7 +61,7 @@ - + Returns a [KinematicCollision3D], which contains information about a collision that occurred during the last call to [method move_and_slide]. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_collision_count] - 1). diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index 43210de686..151b34c430 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -11,64 +11,64 @@ - + Returns [code]true[/code] if you can instance objects from the specified [code]class[/code], [code]false[/code] in other case. - + Returns whether the specified [code]class[/code] is available or not. - - - + + + Returns an array with all the keys in [code]enum[/code] of [code]class[/code] or its ancestry. - - + + Returns an array with all the enums of [code]class[/code] or its ancestry. - - + + Returns the value of the integer constant [code]name[/code] of [code]class[/code] or its ancestry. Always returns 0 when the constant could not be found. - - - + + + Returns which enum the integer constant [code]name[/code] of [code]class[/code] or its ancestry belongs to. - - + + Returns an array with the names all the integer constants of [code]class[/code] or its ancestry. - - + + Returns an array with all the methods of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code]. [b]Note:[/b] In exported release builds the debug info is not available, so the returned dictionaries will contain only method names. @@ -76,75 +76,75 @@ - - + + Returns the value of [code]property[/code] of [code]class[/code] or its ancestry. - - + + Returns an array with all the properties of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. - - + + Returns the [code]signal[/code] data of [code]class[/code] or its ancestry. The returned value is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code]. - - + + Returns an array with all the signals of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] as described in [method class_get_signal]. - - - + + + Returns whether [code]class[/code] or its ancestry has an enum called [code]name[/code] or not. - - + + Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not. - - - + + + Returns whether [code]class[/code] (or its ancestry if [code]no_inheritance[/code] is [code]false[/code]) has a method called [code]method[/code] or not. - - + + Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not. - - - + + + Sets [code]property[/code] value of [code]class[/code] to [code]value[/code]. @@ -157,36 +157,36 @@ - + Returns the names of all the classes that directly or indirectly inherit from [code]class[/code]. - + Returns the parent class of [code]class[/code]. - + Creates an instance of [code]class[/code]. - + Returns whether this [code]class[/code] is enabled or not. - - + + Returns whether [code]inherits[/code] is an ancestor of [code]class[/code] or not. diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml index 4994ef352e..d9f8e17145 100644 --- a/doc/classes/CodeEdit.xml +++ b/doc/classes/CodeEdit.xml @@ -12,14 +12,14 @@ - + Override this method to define how the selected entry should be inserted. If [code]replace[/code] is true, any existing text should be replaced. - + Override this method to define what items in [code]candidates[/code] should be displayed. Both [code]candidates[/code] and the return is a [Array] of [Dictionary], see [method get_code_completion_option] for [Dictionary] content. @@ -27,15 +27,15 @@ - + Override this method to define what happens when the user requests code completion. If [code]force[/code] is true, any checks should be bypassed. - - + + Adds a brace pair. Both the start and end keys must be symbols. Only the start key has to be unique. @@ -43,12 +43,12 @@ - - - - - - + + + + + + Submits an item to the queue of potential candidates for the autocomplete menu. Call [method update_code_completion_options] to update the list. [b]Note:[/b] This list will replace all current candidates. @@ -56,9 +56,9 @@ - - - + + + Adds a comment delimiter. Both the start and end keys must be symbols. Only the start key has to be unique. @@ -67,9 +67,9 @@ - - - + + + Adds a string delimiter. Both the start and end keys must be symbols. Only the start key has to be unique. @@ -78,7 +78,7 @@ - + Returns if the given line is foldable, that is, it has indented lines right below it or a comment / string block. @@ -121,7 +121,7 @@ - + Inserts the selected entry into the text. If [code]replace[/code] is true, any existing text is replaced rather then merged. @@ -146,14 +146,14 @@ - + Folds the given line, if possible (see [method can_fold_line]). - + Gets the matching auto brace close key for [code]open_key[/code]. @@ -172,7 +172,7 @@ - + Gets the completion option at [code]index[/code]. The return [Dictionary] has the following key-values: [code]kind[/code]: [enum CodeCompletionKind] @@ -197,30 +197,30 @@ - + Gets the end key for a string or comment region index. - - + + If [code]line[/code] [code]column[/code] is in a string or comment, returns the end position of the region. If not or no end could be found, both [Vector2] values will be [code]-1[/code]. - + Gets the start key for a string or comment region index. - - + + If [code]line[/code] [code]column[/code] is in a string or comment, returns the start position of the region. If not or no start could be found, both [Vector2] values will be [code]-1[/code]. @@ -251,28 +251,28 @@ - + Returns [code]true[/code] if close key [code]close_key[/code] exists. - + Returns [code]true[/code] if open key [code]open_key[/code] exists. - + Returns [code]true[/code] if comment [code]start_key[/code] exists. - + Returns [code]true[/code] if string [code]start_key[/code] exists. @@ -285,124 +285,124 @@ - - + + Returns delimiter index if [code]line[/code] [code]column[/code] is in a comment. If [code]column[/code] is not provided, will return delimiter index if the entire [code]line[/code] is a comment. Otherwise [code]-1[/code]. - - + + Returns the delimiter index if [code]line[/code] [code]column[/code] is in a string. If [code]column[/code] is not provided, will return the delimiter index if the entire [code]line[/code] is a string. Otherwise [code]-1[/code]. - + Returns whether the line at the specified index is bookmarked or not. - + Returns whether the line at the specified index is breakpointed or not. - + Returns whether the line at the specified index is marked as executing or not. - + Returns whether the line at the specified index is folded or not. - + Removes the comment delimiter with [code]start_key[/code]. - + Removes the string delimiter with [code]start_key[/code]. - + Emits [signal code_completion_requested], if [code]force[/code] is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path or signal. - + Sets the current selected completion option. - + Sets the code hint text. Pass an empty string to clear. - + Sets if the code hint should draw below the text. - - + + Sets the line as bookmarked. - - + + Sets the line as breakpointed. - - + + Sets the line as executing. - + Sets the symbol emitted by [signal symbol_validate] as a valid lookup. - + Toggle the folding of the code block at the given line. @@ -415,7 +415,7 @@ - + Unfolds all lines that were previously folded. @@ -428,7 +428,7 @@ - + Submits all completion options added with [method add_code_completion_option]. Will try to force the autoccomplete menu to popup, if [code]force[/code] is [code]true[/code]. [b]Note:[/b] This will replace all current candidates. @@ -501,7 +501,7 @@ - + Emitted when a breakpoint is added or removed from a line. If the line is moved via backspace a removed is emitted at the old line. @@ -512,15 +512,15 @@ - - - + + + Emitted when the user has clicked on a valid symbol. - + Emitted when the user hovers over a symbol. The symbol should be validated and responded to, by calling [method set_symbol_lookup_word_as_valid]. diff --git a/doc/classes/CodeHighlighter.xml b/doc/classes/CodeHighlighter.xml index b4bde1d00b..fd1f595fc6 100644 --- a/doc/classes/CodeHighlighter.xml +++ b/doc/classes/CodeHighlighter.xml @@ -11,10 +11,10 @@ - - - - + + + + Adds a color region such as comments or strings. Both the start and end keys must be symbols. Only the start key has to be unique. @@ -23,8 +23,8 @@ - - + + Sets the color for a keyword. The keyword cannot contain any symbols except '_'. @@ -32,8 +32,8 @@ - - + + Sets the color for a member keyword. The member keyword cannot contain any symbols except '_'. @@ -60,56 +60,56 @@ - + Returns the color for a keyword. - + Returns the color for a member keyword. - + Returns [code]true[/code] if the start key exists, else [code]false[/code]. - + Returns [code]true[/code] if the keyword exists, else [code]false[/code]. - + Returns [code]true[/code] if the member keyword exists, else [code]false[/code]. - + Removes the color region that uses that start key. - + Removes the keyword. - + Removes the member keyword. diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index 95d99855f6..31858bf080 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -12,9 +12,9 @@ - - - + + + Accepts unhandled [InputEvent]s. [code]shape_idx[/code] is the child index of the clicked [Shape2D]. Connect to the [code]input_event[/code] signal to easily pick up these events. [b]Note:[/b] [method _input_event] requires [member input_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set. @@ -22,21 +22,21 @@ - + Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference. - + Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [code]layer_number[/code] between 1 and 32. - + Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. @@ -49,7 +49,7 @@ - + Returns the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code]. @@ -62,136 +62,136 @@ - + If [code]true[/code], the shape owner and its shapes are disabled. - + Returns [code]true[/code] if collisions for the shape owner originating from this [CollisionObject2D] will not be reported to collided with [CollisionObject2D]s. - + Removes the given shape owner. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member collision_layer], given a [code]layer_number[/code] between 1 and 32. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. - + Returns the [code]owner_id[/code] of the given shape. - - + + Adds a [Shape2D] to the shape owner. - + Removes all shapes from the shape owner. - + Returns the parent object of the given shape owner. - - + + Returns the [Shape2D] with the given id from the given shape owner. - + Returns the number of shapes the given shape owner contains. - - + + Returns the child index of the [Shape2D] with the given id from the given shape owner. - + Returns the shape owner's [Transform2D]. - - + + Removes a shape from the given shape owner. - - + + If [code]true[/code], disables the given shape owner. - - + + If [code]enable[/code] is [code]true[/code], collisions for the shape owner originating from this [CollisionObject2D] will not be reported to collided with [CollisionObject2D]s. - - + + Sets the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code] to [code]margin[/code] pixels. - - + + Sets the [Transform2D] of the given shape owner. @@ -215,9 +215,9 @@ - - - + + + Emitted when an input event occurs. Requires [member input_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set. See [method _input_event] for details. @@ -235,13 +235,13 @@ - + Emitted when the mouse pointer enters any of this object's shapes or moves from one shape to another. [code]shape_idx[/code] is the child index of the newly entered [Shape2D]. Requires [member input_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set. - + Emitted when the mouse pointer exits any of this object's shapes. [code]shape_idx[/code] is the child index of the exited [Shape2D]. Requires [member input_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set. diff --git a/doc/classes/CollisionObject3D.xml b/doc/classes/CollisionObject3D.xml index 7284a7e341..1319274920 100644 --- a/doc/classes/CollisionObject3D.xml +++ b/doc/classes/CollisionObject3D.xml @@ -11,11 +11,11 @@ - - - - - + + + + + Receives unhandled [InputEvent]s. [code]position[/code] is the location in world space of the mouse pointer on the surface of the shape with index [code]shape_idx[/code] and [code]normal[/code] is the normal vector of the surface at that point. Connect to the [signal input_event] signal to easily pick up these events. [b]Note:[/b] [method _input_event] requires [member input_ray_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set. @@ -23,21 +23,21 @@ - + Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference. - + Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [code]layer_number[/code] between 1 and 32. - + Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. @@ -56,113 +56,113 @@ - + If [code]true[/code], the shape owner and its shapes are disabled. - + Removes the given shape owner. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member collision_layer], given a [code]layer_number[/code] between 1 and 32. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. - + Returns the [code]owner_id[/code] of the given shape. - - + + Adds a [Shape3D] to the shape owner. - + Removes all shapes from the shape owner. - + Returns the parent object of the given shape owner. - - + + Returns the [Shape3D] with the given id from the given shape owner. - + Returns the number of shapes the given shape owner contains. - - + + Returns the child index of the [Shape3D] with the given id from the given shape owner. - + Returns the shape owner's [Transform3D]. - - + + Removes a shape from the given shape owner. - - + + If [code]true[/code], disables the given shape owner. - - + + Sets the [Transform3D] of the given shape owner. @@ -189,11 +189,11 @@ - - - - - + + + + + Emitted when the object receives an unhandled [InputEvent]. [code]position[/code] is the location in world space of the mouse pointer on the surface of the shape with index [code]shape_idx[/code] and [code]normal[/code] is the normal vector of the surface at that point. diff --git a/doc/classes/CollisionShape3D.xml b/doc/classes/CollisionShape3D.xml index 521a11effd..c8423dac9e 100644 --- a/doc/classes/CollisionShape3D.xml +++ b/doc/classes/CollisionShape3D.xml @@ -21,7 +21,7 @@ - + If this method exists within a script it will be called whenever the shape resource has been modified. diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 59ad104ad1..0ed623e0bc 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -24,8 +24,8 @@ - - + + Constructs a [Color] from an existing color, but with a custom alpha value. [codeblocks] @@ -40,31 +40,31 @@ - + Constructs a [Color] as a copy of the given [Color]. - + Constructs a [Color] either from an HTML color code or from a standardized color name. Supported color names are the same as the constants. - - + + Constructs a [Color] either from an HTML color code or from a standardized color name, with [code]alpha[/code] on the range of 0 to 1. Supported color names are the same as the constants. - - - + + + Constructs a [Color] from RGB values, typically between 0 and 1. Alpha will be 1. [codeblocks] @@ -79,10 +79,10 @@ - - - - + + + + Constructs a [Color] from RGBA values, typically between 0 and 1. [codeblocks] @@ -99,7 +99,7 @@ - + Returns a new color resulting from blending this color over another. If the color is opaque, the result is also opaque. The second color may have a range of alpha values. [codeblocks] @@ -118,15 +118,15 @@ - - + + Returns a new color with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. - + Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1). [codeblocks] @@ -143,16 +143,16 @@ - + - - - - + + + + Constructs a color from an [url=https://en.wikipedia.org/wiki/HSL_and_HSV]HSV profile[/url]. [code]h[/code] (hue), [code]s[/code] (saturation), and [code]v[/code] (value) are typically between 0 and 1. [codeblocks] @@ -167,10 +167,10 @@ - - - - + + + + Constructs a color from an [url=https://bottosson.github.io/posts/colorpicker/]OK HSL profile[/url]. [code]h[/code] (hue), [code]s[/code] (saturation), and [code]v[/code] (value) are typically between 0 and 1. [codeblocks] @@ -185,14 +185,14 @@ - + - - + + @@ -206,7 +206,7 @@ - + @@ -217,25 +217,25 @@ - + - + - + - + Returns a new color from [code]rgba[/code], an HTML hexadecimal color string. [code]rgba[/code] is not case sensitive, and may be prefixed with a '#' character. [code]rgba[/code] must be a valid three-digit or six-digit hexadecimal color string, and may contain an alpha channel value. If [code]rgba[/code] does not contain an alpha channel value, an alpha channel value of 1.0 is applied. @@ -255,7 +255,7 @@ - + Returns [code]true[/code] if [code]color[/code] is a valid HTML hexadecimal color string. [code]color[/code] is not case sensitive, and may be prefixed with a '#' character. For a string to be valid it must be three-digit or six-digit hexadecimal, and may contain an alpha channel value. @@ -297,15 +297,15 @@ - + Returns [code]true[/code] if this color and [code]color[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. - - + + Returns the linear interpolation with another color. The interpolation factor [code]weight[/code] is between 0 and 1. [codeblocks] @@ -324,7 +324,7 @@ - + Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1). [codeblocks] @@ -417,7 +417,7 @@ - + Returns the color converted to an HTML hexadecimal color string in RGBA format (ex: [code]ff34f822[/code]). Setting [code]with_alpha[/code] to [code]false[/code] excludes alpha from the hexadecimal string (and uses RGB instead of RGBA format). @@ -946,7 +946,7 @@ - + Returns [code]true[/code] if the colors are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -954,63 +954,63 @@ - + Multiplies each component of the [Color] by the components of the given [Color]. - + Multiplies each component of the [Color] by the given [float]. - + Multiplies each component of the [Color] by the given [int]. - + Adds each component of the [Color] with the components of the given [Color]. - + Subtracts each component of the [Color] by the components of the given [Color]. - + Divides each component of the [Color] by the components of the given [Color]. - + Divides each component of the [Color] by the given [float]. - + Divides each component of the [Color] by the given [int]. - + Returns [code]true[/code] if the colors are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -1018,7 +1018,7 @@ - + Access color components using their index. [code]c[0][/code] is equivalent to [code]c.r[/code], [code]c[1][/code] is equivalent to [code]c.g[/code], [code]c[2][/code] is equivalent to [code]c.b[/code], and [code]c[3][/code] is equivalent to [code]c.a[/code]. diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index cc9c5877c5..705d2282c1 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -13,7 +13,7 @@ - + Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. [b]Note:[/b] The presets list is only for [i]this[/i] color picker. @@ -21,7 +21,7 @@ - + Removes the given color from the list of color presets of this color picker. @@ -58,19 +58,19 @@ - + Emitted when the color is changed. - + Emitted when a preset is added. - + Emitted when a preset is removed. diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index 75a715789c..b7a0bdfb0c 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -39,7 +39,7 @@ - + Emitted when the color changes. diff --git a/doc/classes/CompressedTexture2D.xml b/doc/classes/CompressedTexture2D.xml index 5f73b55f69..f74265b8d5 100644 --- a/doc/classes/CompressedTexture2D.xml +++ b/doc/classes/CompressedTexture2D.xml @@ -11,7 +11,7 @@ - + Loads the texture from the given path. diff --git a/doc/classes/CompressedTexture3D.xml b/doc/classes/CompressedTexture3D.xml index de7a93d788..50bd025861 100644 --- a/doc/classes/CompressedTexture3D.xml +++ b/doc/classes/CompressedTexture3D.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/CompressedTextureLayered.xml b/doc/classes/CompressedTextureLayered.xml index 03bea84ba4..547679c0f0 100644 --- a/doc/classes/CompressedTextureLayered.xml +++ b/doc/classes/CompressedTextureLayered.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/ConcavePolygonShape3D.xml b/doc/classes/ConcavePolygonShape3D.xml index 60d7e32492..6a54b4bda7 100644 --- a/doc/classes/ConcavePolygonShape3D.xml +++ b/doc/classes/ConcavePolygonShape3D.xml @@ -20,7 +20,7 @@ - + Sets the faces (an array of triangles). diff --git a/doc/classes/ConeTwistJoint3D.xml b/doc/classes/ConeTwistJoint3D.xml index f78a5b5332..5f2ad109f2 100644 --- a/doc/classes/ConeTwistJoint3D.xml +++ b/doc/classes/ConeTwistJoint3D.xml @@ -13,14 +13,14 @@ - + - - + + diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index b766981f1e..ecd317e064 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -100,22 +100,22 @@ - + Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist. - - + + Deletes the specified key in a section. Raises an error if either the section or the key do not exist. - + Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist. @@ -128,24 +128,24 @@ - - - + + + Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback [code]default[/code] value. If [code]default[/code] is not specified or set to [code]null[/code], an error is also raised. - + Returns [code]true[/code] if the specified section exists. - - + + Returns [code]true[/code] if the specified section-key pair exists. @@ -154,7 +154,7 @@ - + Loads the config file specified as a parameter. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -162,8 +162,8 @@ - - + + Loads the encrypted config file specified as a parameter, using the provided [code]key[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -171,8 +171,8 @@ - - + + Loads the encrypted config file specified as a parameter, using the provided [code]password[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -180,7 +180,7 @@ - + Parses the passed string as the contents of a config file. The string is parsed and loaded in the ConfigFile object which the method was called on. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -188,7 +188,7 @@ - + Saves the contents of the [ConfigFile] object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -196,8 +196,8 @@ - - + + Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]key[/code] to encrypt it. The output file uses an INI-style structure. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -205,8 +205,8 @@ - - + + Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]password[/code] to encrypt it. The output file uses an INI-style structure. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -214,9 +214,9 @@ - - - + + + Assigns a value to the specified key of the specified section. If either the section or the key do not exist, they are created. Passing a [code]null[/code] value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. diff --git a/doc/classes/Container.xml b/doc/classes/Container.xml index 900997d119..a13e1598b2 100644 --- a/doc/classes/Container.xml +++ b/doc/classes/Container.xml @@ -27,8 +27,8 @@ - - + + Fit a child control in a given rect. This is mainly a helper for creating custom container classes. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 9fc80e1aab..ad5dcdfc45 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -24,8 +24,8 @@ - - + + Godot calls this method to test if [code]data[/code] from a control's [method _get_drag_data] can be dropped at [code]position[/code]. [code]position[/code] is local to this control. This method should only be used to test the data. Process the data in [method _drop_data]. @@ -49,8 +49,8 @@ - - + + Godot calls this method to pass you the [code]data[/code] from a control's [method _get_drag_data] result. Godot first calls [method _can_drop_data] to test if [code]data[/code] is allowed to drop at [code]position[/code] where [code]position[/code] is local to this control. [codeblocks] @@ -75,7 +75,7 @@ - + Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns [code]null[/code] if there is no data to drag. Controls that want to receive drop data should implement [method _can_drop_data] and [method _drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method. @@ -107,7 +107,7 @@ - + Virtual method to be implemented by the user. Use this method to process and accept inputs on UI elements. See [method accept_event]. Example: clicking a control. @@ -143,7 +143,7 @@ - + Virtual method to be implemented by the user. Returns whether the given [code]point[/code] is inside this control. If not overridden, default behavior is checking if the point is within control's Rect. @@ -152,7 +152,7 @@ - + Virtual method to be implemented by the user. Returns a [Control] node that should be used as a tooltip instead of the default one. The [code]for_text[/code] includes the contents of the [member hint_tooltip] property. The returned node must be of type [Control] or Control-derived. It can have child nodes of any type. It is freed when the tooltip disappears, so make sure you always provide a new instance (if you want to use a pre-existing node from your scene tree, you can duplicate it and pass the duplicated instance). When [code]null[/code] or a non-Control node is returned, the default tooltip will be used instead. @@ -197,8 +197,8 @@ - - + + User defined BiDi algorithm override function. Returns [code]Array[/code] of [code]Vector2i[/code] text ranges, in the left-to-right order. Ranges should cover full source [code]text[/code] without overlaps. BiDi algorithm will be used on each range separately. @@ -212,8 +212,8 @@ - - + + Creates a local override for a theme [Color] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_color_override]. See also [method get_theme_color]. @@ -240,8 +240,8 @@ - - + + Creates a local override for a theme constant with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_constant_override]. See also [method get_theme_constant]. @@ -249,8 +249,8 @@ - - + + Creates a local override for a theme [Font] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_override]. See also [method get_theme_font]. @@ -258,8 +258,8 @@ - - + + Creates a local override for a theme font size with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_size_override]. See also [method get_theme_font_size]. @@ -267,8 +267,8 @@ - - + + Creates a local override for a theme icon with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_icon_override]. See also [method get_theme_icon]. @@ -276,8 +276,8 @@ - - + + Creates a local override for a theme [StyleBox] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_stylebox_override]. See also [method get_theme_stylebox]. @@ -334,8 +334,8 @@ - - + + Forces drag and bypasses [method _get_drag_data] and [method set_drag_preview] by passing [code]data[/code] and [code]preview[/code]. Drag will start even if the mouse is neither over nor pressed on this control. The methods [method _can_drop_data] and [method _drop_data] must be implemented on controls that want to receive drop data. @@ -343,7 +343,7 @@ - + Returns the anchor for the specified [enum Side]. A getter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top]. @@ -362,7 +362,7 @@ - + Returns the mouse cursor shape the control displays on mouse hover. See [enum CursorShape]. @@ -375,7 +375,7 @@ - + Returns the focus neighbor for the specified [enum Side]. A getter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top]. @@ -394,7 +394,7 @@ - + Returns the anchor for the specified [enum Side]. A getter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top]. @@ -432,8 +432,8 @@ - - + + Returns a [Color] from the first matching [Theme] in the tree if that [Theme] has a color item with the specified [code]name[/code] and [code]theme_type[/code]. If [code]theme_type[/code] is omitted the class name of the current control is used as the type, or [member theme_type_variation] if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance. If the type is a variation its base types are checked, in order of dependency, then the control's class name and its parent classes are checked. For the current control its local overrides are considered first (see [method add_theme_color_override]), then its assigned [member theme]. After the current control, each parent control and its assigned [member theme] are considered; controls without a [member theme] assigned are skipped. If no matching [Theme] is found in the tree, a custom project [Theme] (see [member ProjectSettings.gui/theme/custom]) and the default [Theme] are used. @@ -459,8 +459,8 @@ - - + + Returns a constant from the first matching [Theme] in the tree if that [Theme] has a constant item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -489,8 +489,8 @@ - - + + Returns a [Font] from the first matching [Theme] in the tree if that [Theme] has a font item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -498,8 +498,8 @@ - - + + Returns a font size from the first matching [Theme] in the tree if that [Theme] has a font size item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -507,8 +507,8 @@ - - + + Returns an icon from the first matching [Theme] in the tree if that [Theme] has an icon item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -516,8 +516,8 @@ - - + + Returns a [StyleBox] from the first matching [Theme] in the tree if that [Theme] has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -525,7 +525,7 @@ - + Returns the tooltip, which will appear when the cursor is resting over this control. See [member hint_tooltip]. @@ -562,8 +562,8 @@ - - + + Returns [code]true[/code] if there is a matching [Theme] in the tree that has a color item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -571,7 +571,7 @@ - + Returns [code]true[/code] if there is a local override for a theme [Color] with the specified [code]name[/code] in this [Control] node. See [method add_theme_color_override]. @@ -579,8 +579,8 @@ - - + + Returns [code]true[/code] if there is a matching [Theme] in the tree that has a constant item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -588,7 +588,7 @@ - + Returns [code]true[/code] if there is a local override for a theme constant with the specified [code]name[/code] in this [Control] node. See [method add_theme_constant_override]. @@ -596,8 +596,8 @@ - - + + Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -605,7 +605,7 @@ - + Returns [code]true[/code] if there is a local override for a theme [Font] with the specified [code]name[/code] in this [Control] node. See [method add_theme_font_override]. @@ -613,8 +613,8 @@ - - + + Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font size item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -622,7 +622,7 @@ - + Returns [code]true[/code] if there is a local override for a theme font size with the specified [code]name[/code] in this [Control] node. See [method add_theme_font_size_override]. @@ -630,8 +630,8 @@ - - + + Returns [code]true[/code] if there is a matching [Theme] in the tree that has an icon item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -639,7 +639,7 @@ - + Returns [code]true[/code] if there is a local override for a theme icon with the specified [code]name[/code] in this [Control] node. See [method add_theme_icon_override]. @@ -647,8 +647,8 @@ - - + + Returns [code]true[/code] if there is a matching [Theme] in the tree that has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code]. See [method get_theme_color] for details. @@ -656,7 +656,7 @@ - + Returns [code]true[/code] if there is a local override for a theme [StyleBox] with the specified [code]name[/code] in this [Control] node. See [method add_theme_stylebox_override]. @@ -683,42 +683,42 @@ - + Removes a local override for a theme [Color] with the specified [code]name[/code] previously added by [method add_theme_color_override] or via the Inspector dock. - + Removes a local override for a theme constant with the specified [code]name[/code] previously added by [method add_theme_constant_override] or via the Inspector dock. - + Removes a local override for a theme [Font] with the specified [code]name[/code] previously added by [method add_theme_font_override] or via the Inspector dock. - + Removes a local override for a theme font size with the specified [code]name[/code] previously added by [method add_theme_font_size_override] or via the Inspector dock. - + Removes a local override for a theme icon with the specified [code]name[/code] previously added by [method add_theme_icon_override] or via the Inspector dock. - + Removes a local override for a theme [StyleBox] with the specified [code]name[/code] previously added by [method add_theme_stylebox_override] or via the Inspector dock. @@ -731,10 +731,10 @@ - - - - + + + + Sets the anchor for the specified [enum Side] to [code]anchor[/code]. A setter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top]. If [code]keep_offset[/code] is [code]true[/code], offsets aren't updated after this operation. @@ -743,27 +743,27 @@ - - - - + + + + Works the same as [method set_anchor], but instead of [code]keep_offset[/code] argument and automatic update of offset, it allows to set the offset yourself (see [method set_offset]). - - - + + + Sets both anchor preset and offset preset. See [method set_anchors_preset] and [method set_offsets_preset]. - - + + Sets the anchors to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor. If [code]keep_offsets[/code] is [code]true[/code], control's position will also be updated. @@ -771,14 +771,14 @@ - + Sets [member offset_left] and [member offset_top] at the same time. Equivalent of changing [member position]. - + Forwards the handling of this control's drag and drop to [code]target[/code] object. Forwarding can be implemented in the target object similar to the methods [method _get_drag_data], [method _can_drop_data], and [method _drop_data] but with two differences: @@ -843,7 +843,7 @@ - + Shows the given control at the mouse pointer. A good time to call this method is in [method _get_drag_data]. The control must not be in the scene tree. You should not free the control, and you should not keep a reference to the control beyond the duration of the drag. It will be deleted automatically after the drag has ended. [codeblocks] @@ -877,23 +877,23 @@ - + Sets [member offset_right] and [member offset_bottom] at the same time. - - + + Sets the anchor for the specified [enum Side] to the [Control] at [code]neighbor[/code] node path. A setter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top]. - - + + Sets the [member global_position] to given [code]position[/code]. If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets. @@ -901,17 +901,17 @@ - - + + Sets the offset for the specified [enum Side] to [code]offset[/code]. A setter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top]. - - - + + + Sets the offsets to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor. Use parameter [code]resize_mode[/code] with constants from [enum Control.LayoutPresetMode] to better determine the resulting size of the [Control]. Constant size will be ignored if used with presets that change size, e.g. [code]PRESET_LEFT_WIDE[/code]. @@ -920,8 +920,8 @@ - - + + Sets the [member position] to given [code]position[/code]. If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets. @@ -929,8 +929,8 @@ - - + + Sets the size (see [member size]). If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets. @@ -944,7 +944,7 @@ - + Moves the mouse cursor to [code]position[/code], relative to [member position] of this [Control]. @@ -1105,7 +1105,7 @@ - + Emitted when the node receives an [InputEvent]. diff --git a/doc/classes/ConvexPolygonShape2D.xml b/doc/classes/ConvexPolygonShape2D.xml index df96b50fc1..862626d9b6 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 Geometry2D.convex_hull] for details. diff --git a/doc/classes/Crypto.xml b/doc/classes/Crypto.xml index 4936fc1d85..ed5b642f90 100644 --- a/doc/classes/Crypto.xml +++ b/doc/classes/Crypto.xml @@ -74,8 +74,8 @@ - - + + Compares two [PackedByteArray]s for equality without leaking timing information in order to prevent timing attacks. See [url=https://paragonie.com/blog/2015/11/preventing-timing-attacks-on-string-comparison-with-double-hmac-strategy]this blog post[/url] for more information. @@ -83,8 +83,8 @@ - - + + Decrypt the given [code]ciphertext[/code] with the provided private [code]key[/code]. [b]Note:[/b] The maximum size of accepted ciphertext is limited by the key size. @@ -92,8 +92,8 @@ - - + + Encrypt the given [code]plaintext[/code] with the provided public [code]key[/code]. [b]Note:[/b] The maximum size of accepted plaintext is limited by the key size. @@ -101,24 +101,24 @@ - + Generates a [PackedByteArray] of cryptographically secure random bytes with given [code]size[/code]. - + Generates an RSA [CryptoKey] that can be used for creating self-signed certificates and passed to [method StreamPeerSSL.accept_stream]. - - - - + + + + Generates a self-signed [X509Certificate] from the given [CryptoKey] and [code]issuer_name[/code]. The certificate validity will be defined by [code]not_before[/code] and [code]not_after[/code] (first valid date and last valid date). The [code]issuer_name[/code] must contain at least "CN=" (common name, i.e. the domain name), "O=" (organization, i.e. your company name), "C=" (country, i.e. 2 lettered ISO-3166 code of the country the organization is based in). A small example to generate an RSA key and a X509 self-signed certificate. @@ -142,9 +142,9 @@ - - - + + + Generates an [url=https://en.wikipedia.org/wiki/HMAC]HMAC[/url] digest of [code]msg[/code] using [code]key[/code]. The [code]hash_type[/code] parameter is the hashing algorithm that is used for the inner and outer hashes. Currently, only [constant HashingContext.HASH_SHA256] and [constant HashingContext.HASH_SHA1] are supported. @@ -152,19 +152,19 @@ - - - + + + Sign a given [code]hash[/code] of type [code]hash_type[/code] with the provided private [code]key[/code]. - - - - + + + + Verify that a given [code]signature[/code] for [code]hash[/code] of type [code]hash_type[/code] against the provided public [code]key[/code]. diff --git a/doc/classes/CryptoKey.xml b/doc/classes/CryptoKey.xml index 8496c6dec1..4859e182fe 100644 --- a/doc/classes/CryptoKey.xml +++ b/doc/classes/CryptoKey.xml @@ -18,8 +18,8 @@ - - + + Loads a key from [code]path[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be loaded. [b]Note:[/b] [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. @@ -27,16 +27,16 @@ - - + + Loads a key from the given [code]string[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be loaded. - - + + Saves a key to the given [code]path[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be saved. [b]Note:[/b] [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. @@ -44,7 +44,7 @@ - + Returns a string containing the key in PEM format. If [code]public_only[/code] is [code]true[/code], only the public key will be included. diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml index 179b0344c2..ca6c92f2aa 100644 --- a/doc/classes/Curve.xml +++ b/doc/classes/Curve.xml @@ -12,11 +12,11 @@ - - - - - + + + + + Adds a point to the curve. For each side, if the [code]*_mode[/code] is [constant TANGENT_LINEAR], the [code]*_tangent[/code] angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the [code]*_tangent[/code] angle if [code]*_mode[/code] is set to [constant TANGENT_FREE]. @@ -41,104 +41,104 @@ - + Returns the left [enum TangentMode] for the point at [code]index[/code]. - + Returns the left tangent angle (in degrees) for the point at [code]index[/code]. - + Returns the curve coordinates for the point at [code]index[/code]. - + Returns the right [enum TangentMode] for the point at [code]index[/code]. - + Returns the right tangent angle (in degrees) for the point at [code]index[/code]. - + Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve. - + Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked. - + Removes the point at [code]index[/code] from the curve. - - + + Sets the left [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code]. - - + + Sets the left tangent angle for the point at [code]index[/code] to [code]tangent[/code]. - - + + Sets the offset from [code]0.5[/code]. - - + + Sets the right [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code]. - - + + Sets the right tangent angle for the point at [code]index[/code] to [code]tangent[/code]. - - + + Assigns the vertical position [code]y[/code] to the point at [code]index[/code]. diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index 3bba825aaa..09e6e23410 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -12,10 +12,10 @@ - - - - + + + + Adds a point to a curve at [code]position[/code] relative to the [Curve2D]'s position, with control points [code]in[/code] and [code]out[/code]. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position <0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. @@ -41,7 +41,7 @@ - + Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked]. [code]to_point[/code] must be in this curve's local space. @@ -49,7 +49,7 @@ - + Returns the closest baked point (in curve's local space) to [code]to_point[/code]. [code]to_point[/code] must be in this curve's local space. @@ -57,29 +57,29 @@ - + Returns the position of the control point leading to the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code]. - + Returns the position of the control point leading out of the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code]. - + Returns the position of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code]. - - + + Returns the position between the vertex [code]idx[/code] and the vertex [code]idx + 1[/code], where [code]t[/code] controls if the point is the first vertex ([code]t = 0.0[/code]), the last vertex ([code]t = 1.0[/code]), or in between. Values of [code]t[/code] outside the range ([code]0.0 >= t <=1[/code]) give strange, but predictable results. If [code]idx[/code] is out of bounds it is truncated to the first or last vertex, and [code]t[/code] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0)[/code]. @@ -87,8 +87,8 @@ - - + + Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a pixel distance along the curve. To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to [code]true[/code], or linear if set to [code]false[/code]. @@ -97,46 +97,46 @@ - + Returns the position at the vertex [code]fofs[/code]. It calls [method interpolate] using the integer part of [code]fofs[/code] as [code]idx[/code], and its fractional part as [code]t[/code]. - + Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds. - - + + Sets the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. - - + + Sets the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. - - + + Sets the position for the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. - - + + Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index 6457d9681e..7115da8543 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -12,10 +12,10 @@ - - - - + + + + Adds a point to a curve at [code]position[/code] relative to the [Curve3D]'s position, with control points [code]in[/code] and [code]out[/code]. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position <0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. @@ -54,7 +54,7 @@ - + Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked] or [method interpolate_baked_up_vector]. [code]to_point[/code] must be in this curve's local space. @@ -62,7 +62,7 @@ - + Returns the closest baked point (in curve's local space) to [code]to_point[/code]. [code]to_point[/code] must be in this curve's local space. @@ -70,36 +70,36 @@ - + Returns the position of the control point leading to the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. - + Returns the position of the control point leading out of the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. - + Returns the position of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. - + Returns the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code]0[/code]. - - + + Returns the position between the vertex [code]idx[/code] and the vertex [code]idx + 1[/code], where [code]t[/code] controls if the point is the first vertex ([code]t = 0.0[/code]), the last vertex ([code]t = 1.0[/code]), or in between. Values of [code]t[/code] outside the range ([code]0.0 >= t <=1[/code]) give strange, but predictable results. If [code]idx[/code] is out of bounds it is truncated to the first or last vertex, and [code]t[/code] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. @@ -107,8 +107,8 @@ - - + + Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve. To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to [code]true[/code], or linear if set to [code]false[/code]. @@ -117,8 +117,8 @@ - - + + Returns an up vector within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve. To do that, it finds the two cached up vectors where the [code]offset[/code] lies between, then interpolates the values. If [code]apply_tilt[/code] is [code]true[/code], an interpolated tilt is applied to the interpolated up vector. @@ -127,46 +127,46 @@ - + Returns the position at the vertex [code]fofs[/code]. It calls [method interpolate] using the integer part of [code]fofs[/code] as [code]idx[/code], and its fractional part as [code]t[/code]. - + Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds. - - + + Sets the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. - - + + Sets the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. - - + + Sets the position for the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. - - + + Sets the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow3D], this tilt is an offset over the natural tilt the [PathFollow3D] calculates. @@ -174,8 +174,8 @@ - - + + Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. diff --git a/doc/classes/DTLSServer.xml b/doc/classes/DTLSServer.xml index 5d8a2bc16d..562d16fec7 100644 --- a/doc/classes/DTLSServer.xml +++ b/doc/classes/DTLSServer.xml @@ -148,16 +148,16 @@ - - - + + + Setup the DTLS server to use the given [code]private_key[/code] and provide the given [code]certificate[/code] to clients. You can pass the optional [code]chain[/code] parameter to provide additional CA chain information along with the certificate. - + Try to initiate the DTLS handshake with the given [code]udp_peer[/code] which must be already connected (see [method PacketPeerUDP.connect_to_host]). [b]Note:[/b] You must check that the state of the return PacketPeerUDP is [constant PacketPeerDTLS.STATUS_HANDSHAKING], as it is normal that 50% of the new connections will be invalid due to cookie exchange. diff --git a/doc/classes/Decal.xml b/doc/classes/Decal.xml index 3322ab4c66..b9d3f1d81e 100644 --- a/doc/classes/Decal.xml +++ b/doc/classes/Decal.xml @@ -14,7 +14,7 @@ - + Returns the [Texture2D] associated with the specified [enum DecalTexture]. This is a convenience method, in most cases you should access the texture directly. For example, instead of [code]albedo_tex = $Decal.get_texture(Decal.TEXTURE_ALBEDO)[/code], use [code]albedo_tex = $Decal.texture_albedo[/code]. @@ -35,8 +35,8 @@ - - + + Sets the [Texture2D] associated with the specified [enum DecalTexture]. This is a convenience method, in most cases you should access the texture directly. For example, instead of [code]$Decal.set_texture(Decal.TEXTURE_ALBEDO, albedo_tex)[/code], use [code]$Decal.texture_albedo = albedo_tex[/code]. diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index 6f2ad5205c..68fa069618 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -190,7 +190,7 @@ - + Constructs a [Dictionary] as a copy of the given [Dictionary]. @@ -205,14 +205,14 @@ - + Creates a copy of the dictionary, and returns it. The [code]deep[/code] parameter causes inner dictionaries and arrays to be copied recursively, but does not apply to objects. - + Erase a dictionary key/value pair by key. Returns [code]true[/code] if the given key was present in the dictionary, [code]false[/code] otherwise. [b]Note:[/b] Don't erase elements while iterating over the dictionary. You can iterate over the [method keys] array instead. @@ -220,15 +220,15 @@ - - + + Returns the current value for the specified key in the [Dictionary]. If the key does not exist, the method returns the value of the optional default argument, or [code]null[/code] if it is omitted. - + Returns [code]true[/code] if the dictionary has a given key. [b]Note:[/b] This is equivalent to using the [code]in[/code] operator as follows: @@ -251,7 +251,7 @@ - + Returns [code]true[/code] if the dictionary has all the keys in the given array. @@ -293,8 +293,8 @@ - - + + Adds elements from [code]dictionary[/code] to this [Dictionary]. By default, duplicate keys will not be copied over, unless [code]overwrite[/code] is [code]true[/code]. @@ -315,19 +315,19 @@ - + - + - + diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index bd16fd3936..c3eb469934 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -59,7 +59,7 @@ - + Changes the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. [code]newdir[/code] or [code]../newdir[/code]), or an absolute path (e.g. [code]/tmp/newdir[/code] or [code]res://somedir/newdir[/code]). Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -67,8 +67,8 @@ - - + + Copies the [code]from[/code] file to the [code]to[/code] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -82,7 +82,7 @@ - + Returns whether the target directory exists. The argument can be relative to the current directory, or an absolute path. If the [Directory] is not open, the path is relative to [code]res://[/code]. @@ -90,7 +90,7 @@ - + Returns whether the target file exists. The argument can be relative to the current directory, or an absolute path. If the [Directory] is not open, the path is relative to [code]res://[/code]. @@ -117,7 +117,7 @@ - + On Windows, returns the name of the drive (partition) passed as an argument (e.g. [code]C:[/code]). On macOS, returns the path to the mounted volume passed as an argument. @@ -170,7 +170,7 @@ - + Creates a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see [method make_dir_recursive]). Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -178,7 +178,7 @@ - + Creates a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path. Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -186,7 +186,7 @@ - + Opens an existing directory of the filesystem. The [code]path[/code] argument can be within the project tree ([code]res://folder[/code]), the user directory ([code]user://folder[/code]) or an absolute path of the user filesystem (e.g. [code]/tmp/folder[/code] or [code]C:\tmp\folder[/code]). Returns one of the [enum Error] code constants ([code]OK[/code] on success). @@ -194,7 +194,7 @@ - + Permanently deletes the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. If you don't want to delete the file/directory permanently, use [method OS.move_to_trash] instead. @@ -203,8 +203,8 @@ - - + + Renames (move) the [code]from[/code] file or directory to the [code]to[/code] destination. Both arguments should be paths to files or directories, either relative or absolute. If the destination file or directory exists and is not access-protected, it will be overwritten. Returns one of the [enum Error] code constants ([code]OK[/code] on success). diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index bc6cd88fa5..e642bc7b73 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -28,14 +28,14 @@ - + Sets the user's clipboard content to the given string. - + Sets the user's primary clipboard content to the given string. [b]Note:[/b] This method is only implemented on Linux. @@ -43,10 +43,10 @@ - - - - + + + + @@ -57,45 +57,45 @@ - - - + + + - + - + - - - - + + + + - - - - + + + + - + @@ -134,7 +134,7 @@ - + @@ -145,12 +145,12 @@ - - - - - - + + + + + + Adds a new checkable item with text [code]label[/code] to the global menu with ID [code]menu_root[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -163,13 +163,13 @@ - - - - - - - + + + + + + + Adds a new checkable item with text [code]label[/code] and icon [code]icon[/code] to the global menu with ID [code]menu_root[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -182,13 +182,13 @@ - - - - - - - + + + + + + + Adds a new item with text [code]label[/code] and icon [code]icon[/code] to the global menu with ID [code]menu_root[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -201,13 +201,13 @@ - - - - - - - + + + + + + + Adds a new radio-checkable item with text [code]label[/code] and icon [code]icon[/code] to the global menu with ID [code]menu_root[/code]. [b]Note:[/b] Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method global_menu_set_item_checked] for more info on how to control it. @@ -221,12 +221,12 @@ - - - - - - + + + + + + Adds a new item with text [code]label[/code] to the global menu with ID [code]menu_root[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -239,14 +239,14 @@ - - - - - - - - + + + + + + + + Adds a new item with text [code]label[/code] to the global menu with ID [code]menu_root[/code]. Contrarily to normal binary items, multistate items can have more than two states, as defined by [code]max_states[/code]. Each press or activate of the item will increase the state by one. The default value is defined by [code]default_state[/code]. @@ -260,12 +260,12 @@ - - - - - - + + + + + + Adds a new radio-checkable item with text [code]label[/code] to the global menu with ID [code]menu_root[/code]. [b]Note:[/b] Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method global_menu_set_item_checked] for more info on how to control it. @@ -279,8 +279,8 @@ - - + + Adds a separator between items to the global menu with ID [code]menu_root[/code]. Separators also occupy an index. [b]Note:[/b] This method is implemented on macOS. @@ -293,10 +293,10 @@ - - - - + + + + Adds an item that will act as a submenu of the global menu [code]menu_root[/code]. The [code]submenu[/code] argument is the ID of the global menu root that will be shown when the item is clicked. [b]Note:[/b] This method is implemented on macOS. @@ -309,7 +309,7 @@ - + Removes all items from the global menu with ID [code]menu_root[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -322,8 +322,8 @@ - - + + Returns the accelerator of the item at index [code]idx[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. [b]Note:[/b] This method is implemented on macOS. @@ -331,8 +331,8 @@ - - + + Returns the callback of the item at index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -340,8 +340,8 @@ - - + + Returns the icon of the item at index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -349,8 +349,8 @@ - - + + Returns the index of the item with the specified [code]tag[/code]. Index is automatically assigned to each item by the engine. Index can not be set manually. [b]Note:[/b] This method is implemented on macOS. @@ -358,8 +358,8 @@ - - + + Returns the index of the item with the specified [code]text[/code]. Index is automatically assigned to each item by the engine. Index can not be set manually. [b]Note:[/b] This method is implemented on macOS. @@ -367,8 +367,8 @@ - - + + Returns number of states of an multistate item. See [method global_menu_add_multistate_item] for details. [b]Note:[/b] This method is implemented on macOS. @@ -376,8 +376,8 @@ - - + + Returns the state of an multistate item. See [method global_menu_add_multistate_item] for details. [b]Note:[/b] This method is implemented on macOS. @@ -385,8 +385,8 @@ - - + + Returns the submenu ID of the item at index [code]idx[/code]. See [method global_menu_add_submenu_item] for more info on how to add a submenu. [b]Note:[/b] This method is implemented on macOS. @@ -394,8 +394,8 @@ - - + + Returns the metadata of the specified item, which might be of any type. You can set it with [method global_menu_set_item_tag], which provides a simple way of assigning context data to items. [b]Note:[/b] This method is implemented on macOS. @@ -403,8 +403,8 @@ - - + + Returns the text of the item at index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -412,8 +412,8 @@ - - + + Returns the tooltip associated with the specified index index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -421,8 +421,8 @@ - - + + Returns [code]true[/code] if the item at index [code]idx[/code] is checkable in some way, i.e. if it has a checkbox or radio button. [b]Note:[/b] This method is implemented on macOS. @@ -430,8 +430,8 @@ - - + + Returns [code]true[/code] if the item at index [code]idx[/code] is checked. [b]Note:[/b] This method is implemented on macOS. @@ -439,8 +439,8 @@ - - + + Returns [code]true[/code] if the item at index [code]idx[/code] is disabled. When it is disabled it can't be selected, or its action invoked. See [method global_menu_set_item_disabled] for more info on how to disable an item. @@ -449,8 +449,8 @@ - - + + Returns [code]true[/code] if the item at index [code]idx[/code] has radio button-style checkability. [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. @@ -459,8 +459,8 @@ - - + + Removes the item at index [code]idx[/code] from the global menu [code]menu_root[/code]. [b]Note:[/b] The indices of items after the removed item will be shifted by one. @@ -469,9 +469,9 @@ - - - + + + Sets the accelerator of the item at index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -479,9 +479,9 @@ - - - + + + Sets the callback of the item at index [code]idx[/code]. Callback is emitted when an item is pressed or its accelerator is activated. [b]Note:[/b] This method is implemented on macOS. @@ -489,9 +489,9 @@ - - - + + + Sets whether the item at index [code]idx[/code] has a checkbox. If [code]false[/code], sets the type of the item to plain text. [b]Note:[/b] This method is implemented on macOS. @@ -499,9 +499,9 @@ - - - + + + Sets the checkstate status of the item at index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -509,9 +509,9 @@ - - - + + + Enables/disables the item at index [code]idx[/code]. When it is disabled, it can't be selected and its action can't be invoked. [b]Note:[/b] This method is implemented on macOS. @@ -519,9 +519,9 @@ - - - + + + Replaces the [Texture2D] icon of the specified [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -530,9 +530,9 @@ - - - + + + Sets number of state of an multistate item. See [method global_menu_add_multistate_item] for details. [b]Note:[/b] This method is implemented on macOS. @@ -540,9 +540,9 @@ - - - + + + Sets the type of the item at the specified index [code]idx[/code] to radio button. If [code]false[/code], sets the type of the item to plain text [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. @@ -551,9 +551,9 @@ - - - + + + Sets the state of an multistate item. See [method global_menu_add_multistate_item] for details. [b]Note:[/b] This method is implemented on macOS. @@ -561,9 +561,9 @@ - - - + + + Sets the submenu of the item at index [code]idx[/code]. The submenu is the ID of a global menu root that would be shown when the item is clicked. [b]Note:[/b] This method is implemented on macOS. @@ -571,9 +571,9 @@ - - - + + + Sets the metadata of an item, which may be of any type. You can later get it with [method global_menu_get_item_tag], which provides a simple way of assigning context data to items. [b]Note:[/b] This method is implemented on macOS. @@ -581,9 +581,9 @@ - - - + + + Sets the text of the item at index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -591,9 +591,9 @@ - - - + + + Sets the [String] tooltip of the item at the specified index [code]idx[/code]. [b]Note:[/b] This method is implemented on macOS. @@ -601,7 +601,7 @@ - + @@ -624,7 +624,7 @@ - + Converts a physical (US QWERTY) [code]keycode[/code] to one in the active keyboard layout. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. @@ -639,7 +639,7 @@ - + Returns the ISO-639/BCP-47 language code of the keyboard layout at position [code]index[/code]. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. @@ -647,7 +647,7 @@ - + Returns the localized name of the keyboard layout at position [code]index[/code]. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. @@ -655,7 +655,7 @@ - + Sets active keyboard layout. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. @@ -679,7 +679,7 @@ - + @@ -690,7 +690,7 @@ - + Returns the dots per inch density of the specified screen. If [code]screen[/code] is [/code]SCREEN_OF_MAIN_WINDOW[/code] (the default value), a screen with the main window will be used. [b]Note:[/b] On macOS, returned value is inaccurate if fractional display scaling mode is used. @@ -716,19 +716,19 @@ - + - + - + Returns the current refresh rate of the specified screen. If [code]screen[/code] is [constant SCREEN_OF_MAIN_WINDOW] (the default value), a screen with the main window will be used. [b]Note:[/b] Returns [code]-1.0[/code] if the DisplayServer fails to find the refresh rate for the specified screen. On HTML5, [method screen_get_refresh_rate] will always return [code]-1.0[/code] as there is no way to retrieve the refresh rate on that platform. @@ -742,7 +742,7 @@ - + Returns the scale factor of the specified screen by index. [b]Note:[/b] On macOS returned value is [code]2.0[/code] for hiDPI (Retina) screen, and [code]1.0[/code] for all other cases. @@ -751,13 +751,13 @@ - + - + @@ -768,32 +768,32 @@ - + - + - - + + - + - + @@ -813,7 +813,7 @@ - + Returns the tablet driver name for the given index. [b]Note:[/b] This method is implemented on Windows. @@ -821,7 +821,7 @@ - + Set active tablet driver name. [b]Note:[/b] This method is implemented on Windows. @@ -840,7 +840,7 @@ - + Returns an [PackedStringArray] of voice identifiers for the [code]language[/code]. [b]Note:[/b] This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows. @@ -876,8 +876,8 @@ - - + + Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary. - [code]TTS_UTTERANCE_STARTED[/code], [code]TTS_UTTERANCE_ENDED[/code], and [code]TTS_UTTERANCE_CANCELED[/code] callable's method should take one [int] parameter, the utterance id. @@ -888,13 +888,13 @@ - - - - - - - + + + + + + + Adds an utterance to the queue. If [code]interrupt[/code] is [code]true[/code], the queue is cleared first. - [code]voice[/code] identifier is one of the [code]"id"[/code] values returned by [method tts_get_voices] or one of the values returned by [method tts_get_voices_for_language]. @@ -928,12 +928,12 @@ - - - - - - + + + + + + Shows the virtual keyboard if the platform has one. [code]existing_text[/code] parameter is useful for implementing your own [LineEdit] or [TextEdit], as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions). @@ -947,21 +947,21 @@ - + Sets the mouse cursor position to the given [code]position[/code] relative to an origin at the upper left corner of the currently focused game Window Manager window. - - + + - + @@ -973,47 +973,47 @@ - + - + - - + + Returns the current value of the given window's [code]flag[/code]. - + - + - + Returns the mode of the given window. - - + + Returns internal structure pointers for use in plugins. [b]Note:[/b] This method is implemented on Android, Linux, macOS and Windows. @@ -1021,67 +1021,67 @@ - + Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system. - + Returns the position of the given window to on the screen. - + - + - + Returns the V-Sync mode of the given window. - + - + - - + + - - + + - - + + If set to [code]true[/code], this window will always stay on top of its parent window, parent window will ignore input while this window is opened. [b]Note:[/b] On macOS, exclusive windows are confined to the same space (virtual desktop or screen) as the parent window. @@ -1090,52 +1090,52 @@ - - - + + + Enables or disables the given window's given [code]flag[/code]. See [enum WindowFlags] for possible values and their behavior. - - + + - - + + - - + + - - + + - - + + - - + + Sets the minimum size for the given window to [code]min_size[/code] (in pixels). [b]Note:[/b] By default, the main window has a minimum size of [code]Vector2i(64, 64)[/code]. This prevents issues that can arise when the window is resized to a near-zero size. @@ -1143,8 +1143,8 @@ - - + + Sets window mode for the given window to [code]mode[/code]. See [enum WindowMode] for possible values and how each mode behaves. [b]Note:[/b] Setting the window to fullscreen forcibly sets the borderless flag to [code]true[/code], so make sure to set it back to [code]false[/code] when not wanted. @@ -1152,8 +1152,8 @@ - - + + Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through. Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior). @@ -1185,54 +1185,54 @@ - - + + Sets the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system. Clicking this area will not auto-close this popup. - - + + Sets the position of the given window to [code]position[/code]. - - + + - - + + Sets the size of the given window to [code]size[/code]. - - + + Sets the title of the given window to [code]title[/code]. - - + + - - + + Sets the V-Sync mode of the given window. See [enum DisplayServer.VSyncMode] for possible values and how they affect the behavior of your application. @@ -1241,8 +1241,8 @@ - - + + diff --git a/doc/classes/EditorCommandPalette.xml b/doc/classes/EditorCommandPalette.xml index 2cc07c7f1b..23e9349cb5 100644 --- a/doc/classes/EditorCommandPalette.xml +++ b/doc/classes/EditorCommandPalette.xml @@ -27,10 +27,10 @@ - - - - + + + + Adds a custom command to EditorCommandPalette. - [code]command_name[/code]: [String] (Name of the [b]Command[/b]. This is displayed to the user.) @@ -41,7 +41,7 @@ - + Removes the custom command from EditorCommandPalette. - [code]key_name[/code]: [String] (Name of the key for a particular [b]Command[/b].) diff --git a/doc/classes/EditorDebuggerPlugin.xml b/doc/classes/EditorDebuggerPlugin.xml index ba0a479fa7..0b208fb921 100644 --- a/doc/classes/EditorDebuggerPlugin.xml +++ b/doc/classes/EditorDebuggerPlugin.xml @@ -14,7 +14,7 @@ - + Returns [code]true[/code] if a message capture with given name is present otherwise [code]false[/code]. @@ -39,8 +39,8 @@ - - + + Registers a message capture with given [code]name[/code]. If [code]name[/code] is "my_message" then messages starting with "my_message:" will be called with the given callable. Callable must accept a message string and a data array as argument. If the message and data are valid then callable must return [code]true[/code] otherwise [code]false[/code]. @@ -48,15 +48,15 @@ - - + + Sends a message with given [code]message[/code] and [code]data[/code] array. - + Unregisters the message capture with given name. @@ -64,7 +64,7 @@ - + Emitted when the game enters a break state. diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index f217fbaf48..17697cb20b 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -12,10 +12,10 @@ - - - - + + + + Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. [code]features[/code] is the list of features for the export, [code]is_debug[/code] is [code]true[/code] for debug builds, [code]path[/code] is the target path for the exported project. [code]flags[/code] is only used when running a runnable profile, e.g. when using native run on Android. @@ -28,9 +28,9 @@ - - - + + + Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. [code]path[/code] is the path of the file, [code]type[/code] is the [Resource] represented by the file (e.g. [PackedScene]) and [code]features[/code] is the list of features for the export. Calling [method skip] inside this callback will make the file not included in the export. @@ -38,30 +38,30 @@ - - - + + + Adds a custom file to be exported. [code]path[/code] is the virtual path that can be used to load the file, [code]file[/code] is the binary data of the file. If [code]remap[/code] is [code]true[/code], file will not be exported, but instead remapped to the given [code]path[/code]. - + Adds an iOS bundle file from the given [code]path[/code] to the exported project. - + Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin. - + Adds a dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary. [b]Note:[/b] For static libraries (*.a) works in same way as [code]add_ios_framework[/code]. @@ -70,35 +70,35 @@ - + Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project. - + Adds linker flags for the iOS export. - + Adds content for iOS Property List files. - + Adds a static lib from the given [code]path[/code] to the iOS project. - + Adds file or directory matching [code]path[/code] to [code]PlugIns[/code] directory of macOS app bundle. [b]Note:[/b] This is useful only for macOS exports. @@ -106,9 +106,9 @@ - - - + + + Adds a shared object or a directory containing only shared objects with the given [code]tags[/code] and destination [code]path[/code]. [b]Note:[/b] In case of macOS exports, those shared objects will be added to [code]Frameworks[/code] directory of app bundle. diff --git a/doc/classes/EditorFeatureProfile.xml b/doc/classes/EditorFeatureProfile.xml index a6bdc294ac..f5d6763bce 100644 --- a/doc/classes/EditorFeatureProfile.xml +++ b/doc/classes/EditorFeatureProfile.xml @@ -12,83 +12,83 @@ - + Returns the specified [code]feature[/code]'s human-readable name. - + Returns [code]true[/code] if the class specified by [code]class_name[/code] is disabled. When disabled, the class won't appear in the Create New Node dialog. - + Returns [code]true[/code] if editing for the class specified by [code]class_name[/code] is disabled. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class. - - + + Returns [code]true[/code] if [code]property[/code] is disabled in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code]. - + Returns [code]true[/code] if the [code]feature[/code] is disabled. When a feature is disabled, it will disappear from the editor entirely. - + Loads an editor feature profile from a file. The file must follow the JSON format obtained by using the feature profile manager's [b]Export[/b] button or the [method save_to_file] method. - + Saves the editor feature profile to a file in JSON format. It can then be imported using the feature profile manager's [b]Import[/b] button or the [method load_from_file] method. - - + + If [code]disable[/code] is [code]true[/code], disables the class specified by [code]class_name[/code]. When disabled, the class won't appear in the Create New Node dialog. - - + + If [code]disable[/code] is [code]true[/code], disables editing for the class specified by [code]class_name[/code]. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class. - - - + + + If [code]disable[/code] is [code]true[/code], disables editing for [code]property[/code] in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code]. - - + + If [code]disable[/code] is [code]true[/code], disables the editor feature specified in [code]feature[/code]. When a feature is disabled, it will disappear from the editor entirely. diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index 6fd5abe369..0b1a85ebd1 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -10,8 +10,8 @@ - - + + Adds a comma-delimited file name [code]filter[/code] option to the [EditorFileDialog] with an optional [code]description[/code], which restricts what files can be picked. A [code]filter[/code] should be of the form [code]"filename.extension"[/code], where filename and extension can be [code]*[/code] to match any string. Filters starting with [code].[/code] (i.e. empty filenames) are not allowed. @@ -68,19 +68,19 @@ - + Emitted when a directory is selected. - + Emitted when a file is selected. - + Emitted when multiple files are selected. diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index 402efba34a..5a14dd0672 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -12,7 +12,7 @@ - + Returns the resource type of the file, given the full path. This returns a string such as [code]"Resource"[/code] or [code]"GDScript"[/code], [i]not[/i] a file extension such as [code]".gd"[/code]. @@ -25,7 +25,7 @@ - + Returns a view into the filesystem at [code]path[/code]. @@ -44,7 +44,7 @@ - + Reimports a set of files. Call this if these files or their [code].import[/code] files were directly edited by script or an external program. If the file type changed or the file was newly created, use [method update_file] or [method scan]. @@ -65,7 +65,7 @@ - + Add a file in an existing directory, or schedule file information to be updated on editor restart. Can be used to update text files saved by an external program. This will not import the file. To reimport, call [method reimport_files] or [method scan] methods. @@ -85,19 +85,19 @@ - + Emitted if a resource is reimported. - + Emitted if at least one resource is reloaded when the filesystem is scanned. - + Emitted if the source of any imported file changed. diff --git a/doc/classes/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml index 98fea40a50..3bc004e522 100644 --- a/doc/classes/EditorFileSystemDirectory.xml +++ b/doc/classes/EditorFileSystemDirectory.xml @@ -11,21 +11,21 @@ - + Returns the index of the directory with name [code]name[/code] or [code]-1[/code] if not found. - + Returns the index of the file with name [code]name[/code] or [code]-1[/code] if not found. - + Returns the name of the file at index [code]idx[/code]. @@ -38,35 +38,35 @@ - + Returns [code]true[/code] if the file at index [code]idx[/code] imported properly. - + Returns the path to the file at index [code]idx[/code]. - + Returns the base class of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string. - + Returns the name of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string. - + Returns the resource type of the file at index [code]idx[/code]. This returns a string such as [code]"Resource"[/code] or [code]"GDScript"[/code], [i]not[/i] a file extension such as [code]".gd"[/code]. @@ -91,7 +91,7 @@ - + Returns the subdirectory at index [code]idx[/code]. diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index 2e84d3094f..d3af6c1269 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -116,8 +116,8 @@ - - + + Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: [code]name[/code], [code]default_value[/code], [code]property_hint[/code] (optional), [code]hint_string[/code] (optional), [code]usage[/code] (optional). @@ -136,9 +136,9 @@ - - - + + + This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled. For example: [codeblocks] @@ -174,7 +174,7 @@ - + Gets the name of the options preset at this index. @@ -211,11 +211,11 @@ - - - - - + + + + + Imports [code]source_file[/code] into [code]save_path[/code] with the import [code]options[/code] specified. The [code]platform_variants[/code] and [code]gen_files[/code] arrays will be modified by this function. This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method. diff --git a/doc/classes/EditorInspector.xml b/doc/classes/EditorInspector.xml index 365e1f13a9..280a7bf34a 100644 --- a/doc/classes/EditorInspector.xml +++ b/doc/classes/EditorInspector.xml @@ -23,48 +23,48 @@ - + Emitted when the Edit button of an [Object] has been pressed in the inspector. This is mainly used in the remote scene tree inspector. - + Emitted when a property is removed from the inspector. - + Emitted when a property is edited in the inspector. - - - + + + Emitted when a property is keyed in the inspector. Properties can be keyed by clicking the "key" icon next to a property when the Animation panel is toggled. - + Emitted when a property is selected in the inspector. - - + + Emitted when a boolean property is toggled in the inspector. [b]Note:[/b] This signal is never emitted if the internal [code]autoclear[/code] property enabled. Since this property is always enabled in the editor inspector, this signal is never emitted by the editor itself. - - + + Emitted when a resource is selected in the inspector. diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml index 572d5d9d84..e52046f8c2 100644 --- a/doc/classes/EditorInspectorPlugin.xml +++ b/doc/classes/EditorInspectorPlugin.xml @@ -18,75 +18,75 @@ - + Returns [code]true[/code] if this object can be handled by this plugin. - + Called to allow adding controls at the beginning of the property list for [code]object[/code]. - - + + Called to allow adding controls at the beginning of a category in the property list for [code]object[/code]. - + Called to allow adding controls at the end of the property list for [code]object[/code]. - - + + Called to allow adding controls at the beginning of a group or a sub-group in the property list for [code]object[/code]. - - - - - - - + + + + + + + Called to allow adding property-specific editors to the property list for [code]object[/code]. The added editor control must extend [EditorProperty]. Returning [code]true[/code] removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one. - + Adds a custom control, which is not necessarily a property editor. - - - + + + Adds a property editor for an individual property. The [code]editor[/code] control must extend [EditorProperty]. - - - + + + Adds an editor that allows modifying multiple properties. The [code]editor[/code] control must extend [EditorProperty]. diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index cc2f33ce89..bdd5b87cd8 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -12,24 +12,24 @@ - + Edits the given [Node]. The node will be also selected if it's inside the scene tree. - + Edits the given [Resource]. If the resource is a [Script] you can also edit it with [method edit_script] to specify the line and column position. - - - - + + + + Edits the given [Script]. The line and column on which to open the script can also be specified. The script will be open with the user-configured editor for the script's language which may be an external editor. @@ -145,9 +145,9 @@ - - - + + + Shows the given property on the given [code]object[/code] in the editor's Inspector dock. If [code]inspector_only[/code] is [code]true[/code], plugins will not attempt to edit [code]object[/code]. @@ -160,22 +160,22 @@ - + Returns [code]true[/code] if the specified [code]plugin[/code] is enabled. The plugin name is the same as its directory name. - - + + Returns mesh previews rendered at the given size as an [Array] of [Texture2D]s. - + Opens the scene at the given path. @@ -188,7 +188,7 @@ - + Plays the scene specified by its filepath. @@ -201,7 +201,7 @@ - + Reloads the scene at the given path. @@ -214,30 +214,30 @@ - - + + Saves the scene as a file at [code]path[/code]. - + Selects the file, with the path provided by [code]file[/code], in the FileSystem dock. - + Sets the editor's current main screen to the one specified in [code]name[/code]. [code]name[/code] must match the text of the tab in question exactly ([code]2D[/code], [code]3D[/code], [code]Script[/code], [code]AssetLib[/code]). - - + + Sets the enabled status of a plugin. The plugin name is the same as its directory name. diff --git a/doc/classes/EditorNode3DGizmo.xml b/doc/classes/EditorNode3DGizmo.xml index 2eec5310dc..13bf9e3028 100644 --- a/doc/classes/EditorNode3DGizmo.xml +++ b/doc/classes/EditorNode3DGizmo.xml @@ -11,10 +11,10 @@ - - - - + + + + Override this method to commit a handle being edited (handles must have been previously added by [method add_handles]). This usually means creating an [UndoRedo] action for the change, using the current handle value as "do" and the [code]restore[/code] argument as "undo". If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] value should be directly set, without any [UndoRedo] action. @@ -23,9 +23,9 @@ - - - + + + Override this method to commit a group of subgizmos being edited (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). This usually means creating an [UndoRedo] action for the change, using the current transforms as "do" and the [code]restore[/code] transforms as "undo". If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] transforms should be directly set, without any [UndoRedo] action. @@ -33,8 +33,8 @@ - - + + Override this method to return the name of an edited handle (handles must have been previously added by [method add_handles]). Handles can be named for reference to the user when editing. The [code]secondary[/code] argument is [code]true[/code] when the requested handle is secondary (see [method add_handles] for more information). @@ -42,8 +42,8 @@ - - + + Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the [code]restore[/code] argument in [method _commit_handle]. The [code]secondary[/code] argument is [code]true[/code] when the requested handle is secondary (see [method add_handles] for more information). @@ -51,15 +51,15 @@ - + Override this method to return the current transform of a subgizmo. This transform will be requested at the start of an edit and used as the [code]restore[/code] argument in [method _commit_subgizmos]. - - + + Override this method to return [code]true[/code] whenever the given handle should be highlighted in the editor. The [code]secondary[/code] argument is [code]true[/code] when the requested handle is secondary (see [method add_handles] for more information). @@ -73,10 +73,10 @@ - - - - + + + + Override this method to update the node properties when the user drags a gizmo handle (previously added with [method add_handles]). The provided [code]point[/code] is the mouse position in screen coordinates and the [code]camera[/code] can be used to convert it to raycasts. The [code]secondary[/code] argument is [code]true[/code] when the edited handle is secondary (see [method add_handles] for more information). @@ -84,49 +84,49 @@ - - + + Override this method to update the node properties during subgizmo editing (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). The [code]transform[/code] is given in the Node3D's local coordinate system. - - + + Override this method to allow selecting subgizmos using mouse drag box selection. Given a [code]camera[/code] and a [code]frustum[/code], this method should return which subgizmos are contained within the frustum. The [code]frustum[/code] argument consists of an [code]Array[/code] with all the [code]Plane[/code]s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. - - + + Override this method to allow selecting subgizmos using mouse clicks. Given a [code]camera[/code] and a [code]point[/code] in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. - + Adds the specified [code]segments[/code] to the gizmo's collision shape for picking. Call this method during [method _redraw]. - + Adds collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this method during [method _redraw]. - - - - - + + + + + Adds a list of handles (points) which can be used to edit the properties of the gizmo's Node3D. The [code]ids[/code] argument can be used to specify a custom identifier for each handle, if an empty [code]Array[/code] is passed, the ids will be assigned automatically from the [code]handles[/code] argument order. The [code]secondary[/code] argument marks the added handles as secondary, meaning they will normally have less selection priority than regular handles. When the user is holding the shift key secondary handles will switch to have higher priority than regular handles. This change in priority can be used to place multiple handles at the same point while still giving the user control on their selection. @@ -135,29 +135,29 @@ - - - - + + + + Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this method during [method _redraw]. - - - - + + + + Adds a mesh to the gizmo with the specified [code]material[/code], local [code]transform[/code] and [code]skeleton[/code]. Call this method during [method _redraw]. - - - + + + Adds an unscaled billboard for visualization and selection. Call this method during [method _redraw]. @@ -188,21 +188,21 @@ - + Returns [code]true[/code] if the given subgizmo is currently selected. Can be used to highlight selected elements during [method _redraw]. - + Sets the gizmo's hidden state. If [code]true[/code], the gizmo will be hidden. If [code]false[/code], it will be shown. - + Sets the reference [Node3D] node for the gizmo. [code]node[/code] must inherit from [Node3D]. diff --git a/doc/classes/EditorNode3DGizmoPlugin.xml b/doc/classes/EditorNode3DGizmoPlugin.xml index d194786131..a6f4a3a0f5 100644 --- a/doc/classes/EditorNode3DGizmoPlugin.xml +++ b/doc/classes/EditorNode3DGizmoPlugin.xml @@ -19,11 +19,11 @@ - - - - - + + + + + Override this method to commit a handle being edited (handles must have been previously added by [method EditorNode3DGizmo.add_handles] during [method _redraw]). This usually means creating an [UndoRedo] action for the change, using the current handle value as "do" and the [code]restore[/code] argument as "undo". If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] value should be directly set, without any [UndoRedo] action. @@ -33,10 +33,10 @@ - - - - + + + + Override this method to commit a group of subgizmos being edited (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). This usually means creating an [UndoRedo] action for the change, using the current transforms as "do" and the [code]restore[/code] transforms as "undo". If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] transforms should be directly set, without any [UndoRedo] action. As with all subgizmo methods, transforms are given in local space respect to the gizmo's Node3D. Called for this plugin's active gizmos. @@ -44,7 +44,7 @@ - + Override this method to return a custom [EditorNode3DGizmo] for the spatial nodes of your choice, return [code]null[/code] for the rest of nodes. See also [method _has_gizmo]. @@ -57,18 +57,18 @@ - - - + + + Override this method to provide gizmo's handle names. The [code]secondary[/code] argument is [code]true[/code] when the requested handle is secondary (see [method EditorNode3DGizmo.add_handles] for more information). Called for this plugin's active gizmos. - - - + + + Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the [code]restore[/code] argument in [method _commit_handle]. The [code]secondary[/code] argument is [code]true[/code] when the requested handle is secondary (see [method EditorNode3DGizmo.add_handles] for more information). @@ -84,24 +84,24 @@ - - + + Override this method to return the current transform of a subgizmo. As with all subgizmo methods, the transform should be in local space respect to the gizmo's Node3D. This transform will be requested at the start of an edit and used in the [code]restore[/code] argument in [method _commit_subgizmos]. Called for this plugin's active gizmos. - + Override this method to define which Node3D nodes have a gizmo from this plugin. Whenever a [Node3D] node is added to a scene this method is called, if it returns [code]true[/code] the node gets a generic [EditorNode3DGizmo] assigned and is added to this plugin's list of active gizmos. - - - + + + Override this method to return [code]true[/code] whenever to given handle should be highlighted in the editor. The [code]secondary[/code] argument is [code]true[/code] when the requested handle is secondary (see [method EditorNode3DGizmo.add_handles] for more information). Called for this plugin's active gizmos. @@ -114,18 +114,18 @@ - + Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call [method EditorNode3DGizmo.clear] at the beginning of this method and then add visual elements depending on the node's properties. - - - - - + + + + + Override this method to update the node's properties when the user drags a gizmo handle (previously added with [method EditorNode3DGizmo.add_handles]). The provided [code]point[/code] is the mouse position in screen coordinates and the [code]camera[/code] can be used to convert it to raycasts. The [code]secondary[/code] argument is [code]true[/code] when the edited handle is secondary (see [method EditorNode3DGizmo.add_handles] for more information). @@ -134,44 +134,44 @@ - - - + + + Override this method to update the node properties during subgizmo editing (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). The [code]transform[/code] is given in the Node3D's local coordinate system. Called for this plugin's active gizmos. - - - + + + Override this method to allow selecting subgizmos using mouse drag box selection. Given a [code]camera[/code] and a [code]frustum[/code], this method should return which subgizmos are contained within the frustum. The [code]frustum[/code] argument consists of an [code]Array[/code] with all the [code]Plane[/code]s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, these identifiers can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. Called for this plugin's active gizmos. - - - + + + Override this method to allow selecting subgizmos using mouse clicks. Given a [code]camera[/code] and a [code]point[/code] in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. Called for this plugin's active gizmos. - - + + Adds a new material to the internal material list for the plugin. It can then be accessed with [method get_material]. Should not be overridden. - - - + + + Creates a handle material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_handles]. Should not be overridden. You can optionally provide a texture to use instead of the default icon. @@ -179,29 +179,29 @@ - - - - + + + + Creates an icon material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_unscaled_billboard]. Should not be overridden. - - - - - + + + + + Creates an unshaded material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_mesh] and [method EditorNode3DGizmo.add_lines]. Should not be overridden. - - + + Gets material from the internal list of materials. If an [EditorNode3DGizmo] is provided, it will try to get the corresponding variant (selected and/or editable). diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 2930c2ec22..ab41c1c493 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -38,7 +38,7 @@ - + This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. @@ -51,7 +51,7 @@ - + Called by the engine when the 3D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays]. [codeblocks] @@ -89,7 +89,7 @@ - + This method is the same as [method _forward_3d_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. @@ -97,8 +97,8 @@ - - + + Called when there is a root node in the current edited scene, [method _handles] is implemented and an [InputEvent] happens in the 3D viewport. Intercepts the [InputEvent], if [code]return true[/code] [EditorPlugin] consumes the [code]event[/code], otherwise forwards [code]event[/code] to other Editor classes. Example: [codeblocks] @@ -134,7 +134,7 @@ - + Called by the engine when the 2D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays]. [codeblocks] @@ -172,7 +172,7 @@ - + This method is the same as [method _forward_canvas_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. @@ -180,7 +180,7 @@ - + Called when there is a root node in the current edited scene, [method _handles] is implemented and an [InputEvent] happens in the 2D viewport. Intercepts the [InputEvent], if [code]return true[/code] [EditorPlugin] consumes the [code]event[/code], otherwise forwards [code]event[/code] to other Editor classes. Example: [codeblocks] @@ -274,7 +274,7 @@ - + Override this method to provide the GUI layout of the plugin or any other data you want to be stored. This is used to save the project's editor layout when [method queue_save_layout] is called or the editor layout was changed (for example changing the position of a dock). The data is stored in the [code]editor_layout.cfg[/code] file in the editor metadata directory. Use [method _set_window_layout] to restore your saved layout. @@ -287,7 +287,7 @@ - + Implement this function if your plugin edits a specific type of object (Resource or Node). If you return [code]true[/code], then you will get the functions [method _edit] and [method _make_visible] called when the editor requests them. If you have declared the methods [method _forward_canvas_gui_input] and [method _forward_3d_gui_input] these will be called too. @@ -322,7 +322,7 @@ - + This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. Remember that you have to manage the visibility of all your editor controls manually. @@ -336,7 +336,7 @@ - + Restore the state saved by [method _get_state]. This method is called when the current scene tab is changed in the editor. [b]Note:[/b] Your plugin must implement [method _get_plugin_name], otherwise it will not be recognized and this method will not be called. @@ -349,7 +349,7 @@ - + Restore the plugin GUI layout and data saved by [method _get_window_layout]. This method is called for every plugin on editor startup. Use the provided [code]configuration[/code] file to read your saved data. [codeblock] @@ -361,24 +361,24 @@ - - + + Adds a script at [code]path[/code] to the Autoload list as [code]name[/code]. - - + + Adds a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [method Node.queue_free]. - - + + Adds a custom control to a container (see [enum CustomControlContainer]). There are many locations where custom controls can be added in the editor UI. Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it). @@ -387,8 +387,8 @@ - - + + Adds the control to a specific dock slot (see [enum DockSlot] for options). If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions. @@ -397,10 +397,10 @@ - - - - + + + + Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. When a given node or resource is selected, the base type will be instantiated (e.g. "Node3D", "Control", "Resource"), then the script will be loaded and set to this object. @@ -410,14 +410,14 @@ - + Adds a [Script] as debugger plugin to the Debugger. The script must extend [EditorDebuggerPlugin]. - + Registers a new [EditorExportPlugin]. Export plugins are used to perform tasks when the project is being exported. See [method add_inspector_plugin] for an example of how to register a plugin. @@ -425,8 +425,8 @@ - - + + Registers a new [EditorImportPlugin]. Import plugins are used to import custom and unsupported assets as a custom [Resource] type. If [code]first_priority[/code] is [code]true[/code], the new import plugin is inserted first in the list and takes precedence over pre-existing plugins. @@ -436,7 +436,7 @@ - + Registers a new [EditorInspectorPlugin]. Inspector plugins are used to extend [EditorInspector] and provide custom configuration tools for your object's properties. [b]Note:[/b] Always use [method remove_inspector_plugin] to remove the registered [EditorInspectorPlugin] when your [EditorPlugin] is disabled to prevent leaks and an unexpected behavior. @@ -456,8 +456,8 @@ - - + + Registers a new [EditorSceneFormatImporter]. Scene importers are used to import custom 3D asset formats as scenes. If [code]first_priority[/code] is [code]true[/code], the new import plugin is inserted first in the list and takes precedence over pre-existing plugins. @@ -465,8 +465,8 @@ - - + + Add a [EditorScenePostImportPlugin]. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs. If [code]first_priority[/code] is [code]true[/code], the new import plugin is inserted first in the list and takes precedence over pre-existing plugins. @@ -474,7 +474,7 @@ - + Registers a new [EditorNode3DGizmoPlugin]. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a [Node3D]. See [method add_inspector_plugin] for an example of how to register a plugin. @@ -482,30 +482,30 @@ - - + + Adds a custom menu item to [b]Project > Tools[/b] named [code]name[/code]. When clicked, the provided [code]callable[/code] will be called. - - + + Adds a custom [PopupMenu] submenu under [b]Project > Tools >[/b] [code]name[/code]. Use [code]remove_tool_menu_item(name)[/code] on plugin clean up to remove the menu. - + Registers a custom translation parser plugin for extracting translatable strings from custom files. - + Hooks a callback into the undo/redo action creation when a property is modified in the inspector. This allows, for example, to save other properties that may be lost when a given property is modified. The callback should have 4 arguments: [Object] [code]undo_redo[/code], [Object] [code]modified_object[/code], [String] [code]property[/code] and [Variant] [code]new_value[/code]. They are, respectively, the [UndoRedo] object used by the inspector, the currently modified object, the name of the modified property and the new value the property is about to take. @@ -545,7 +545,7 @@ - + Makes a specific item in the bottom panel visible. @@ -558,106 +558,106 @@ - + Removes an Autoload [code]name[/code] from the list. - + Removes the control from the bottom panel. You have to manually [method Node.queue_free] the control. - - + + Removes the control from the specified container. You have to manually [method Node.queue_free] the control. - + Removes the control from the dock. You have to manually [method Node.queue_free] the control. - + Removes a custom type added by [method add_custom_type]. - + Removes the debugger plugin with given script from the Debugger. - + Removes an export plugin registered by [method add_export_plugin]. - + Removes an import plugin registered by [method add_import_plugin]. - + Removes an inspector plugin registered by [method add_import_plugin] - + Removes a scene format importer registered by [method add_scene_format_importer_plugin]. - + Remove the [EditorScenePostImportPlugin], added with [method add_scene_post_import_plugin]. - + Removes a gizmo plugin registered by [method add_spatial_gizmo_plugin]. - + Removes a menu [code]name[/code] from [b]Project > Tools[/b]. - + Removes a custom translation parser plugin registered by [method add_translation_parser_plugin]. - + Removes a callback previsously added by [method add_undo_redo_inspector_hook_callback]. @@ -683,7 +683,7 @@ - + Emitted when user changes the workspace ([b]2D[/b], [b]3D[/b], [b]Script[/b], [b]AssetLib[/b]). Also works with custom screens defined by plugins. @@ -693,18 +693,18 @@ - + - + Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be [code]null[/code]. - + Emitted when user closes a scene. The argument is file path to a closed scene. diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index 586458bd28..0badcf1639 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -17,17 +17,17 @@ - + If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed. - - - - + + + + If one or several properties have changed, this must be called. [code]field[/code] is used in case your editor can modify fields separately (as an example, Vector3.x). The [code]changing[/code] argument avoids the editor requesting this property to be refreshed (leave as [code]false[/code] if unsure). @@ -52,7 +52,7 @@ - + Puts the [code]editor[/code] control below the property label. The control must be previously added using [method Node.add_child]. @@ -88,77 +88,77 @@ - - + + Emit it if you want multiple properties modified at the same time. Do not use if added via [method EditorInspectorPlugin._parse_property]. - - + + Used by sub-inspectors. Emit it if what was selected was an Object ID. - - + + Emitted when the revertability (i.e., whether it has a non-default value and thus is displayed with a revert icon) of a property has changed. - - + + Do not emit this manually, use the [method emit_changed] method instead. - - + + Emitted when a property was checked. Used internally. - + Emitted when a property was deleted. Used internally. - + Emit it if you want to add this value as an animation key (check for keying being enabled first). - - + + Emit it if you want to key a property with a single value. - - + + Emit it if you want to mark (or unmark) the value of a property for being saved regardless of being equal to the default value. The default value is the one the property will get when the node is just instantiated and can come from an ancestor scene in the inheritance/instancing chain, a script or a builtin class. - - + + If you want a sub-resource to be edited, emit this signal with the resource. - - + + Emitted when selected. Used internally. diff --git a/doc/classes/EditorResourceConversionPlugin.xml b/doc/classes/EditorResourceConversionPlugin.xml index 8a4aee0eef..c40bb1d91e 100644 --- a/doc/classes/EditorResourceConversionPlugin.xml +++ b/doc/classes/EditorResourceConversionPlugin.xml @@ -9,7 +9,7 @@ - + @@ -20,7 +20,7 @@ - + diff --git a/doc/classes/EditorResourcePicker.xml b/doc/classes/EditorResourcePicker.xml index aa8f75d764..f531037f59 100644 --- a/doc/classes/EditorResourcePicker.xml +++ b/doc/classes/EditorResourcePicker.xml @@ -12,14 +12,14 @@ - + This virtual method can be implemented to handle context menu items not handled by default. See [method _set_create_options]. - + This virtual method is called when updating the context menu of [EditorResourcePicker]. Implement this method to override the "New ..." items with your own options. [code]menu_node[/code] is a reference to the [PopupMenu] node. [b]Note:[/b] Implement [method _handle_menu_selected] to handle these custom items. @@ -33,7 +33,7 @@ - + Sets the toggle mode state for the main button. Works only if [member toggle_mode] is set to [code]true[/code]. @@ -55,14 +55,14 @@ - + Emitted when the value of the edited resource was changed. - - + + Emitted when the resource value was set and user clicked to edit it. When [code]edit[/code] is [code]true[/code], the signal was caused by the context menu "Edit" option. diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml index 5df797f516..2953c19761 100644 --- a/doc/classes/EditorResourcePreview.xml +++ b/doc/classes/EditorResourcePreview.xml @@ -12,24 +12,24 @@ - + Create an own, custom preview generator. - + Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted. - - - - + + + + Queue the [code]resource[/code] being edited for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called. [b]Note:[/b] If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. @@ -37,10 +37,10 @@ - - - - + + + + Queue a resource file located at [code]path[/code] for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called. [b]Note:[/b] If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. @@ -48,7 +48,7 @@ - + Removes a custom preview generator. @@ -56,7 +56,7 @@ - + Emitted if a preview was invalidated (changed). [code]path[/code] corresponds to the path of the preview. diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml index d8b4a86a97..f24260cd1b 100644 --- a/doc/classes/EditorResourcePreviewGenerator.xml +++ b/doc/classes/EditorResourcePreviewGenerator.xml @@ -18,8 +18,8 @@ - - + + Generate a preview from a given resource with the specified size. This must always be implemented. Returning an empty texture is an OK way to fail and let another generator take care. @@ -28,8 +28,8 @@ - - + + Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method _generate]. Returning an empty texture is an OK way to fail and let another generator take care. @@ -45,7 +45,7 @@ - + Returns [code]true[/code] if your generator supports the resource of type [code]type[/code]. diff --git a/doc/classes/EditorSceneFormatImporter.xml b/doc/classes/EditorSceneFormatImporter.xml index 0290d7207d..6de9c2c5dc 100644 --- a/doc/classes/EditorSceneFormatImporter.xml +++ b/doc/classes/EditorSceneFormatImporter.xml @@ -22,24 +22,24 @@ - + - - - + + + - - - - + + + + diff --git a/doc/classes/EditorScenePostImport.xml b/doc/classes/EditorScenePostImport.xml index 3adf814947..395b094bf2 100644 --- a/doc/classes/EditorScenePostImport.xml +++ b/doc/classes/EditorScenePostImport.xml @@ -57,7 +57,7 @@ - + Called after the scene was imported. This method must return the modified version of the scene. diff --git a/doc/classes/EditorScenePostImportPlugin.xml b/doc/classes/EditorScenePostImportPlugin.xml index 44d644411d..3ea0e53c01 100644 --- a/doc/classes/EditorScenePostImportPlugin.xml +++ b/doc/classes/EditorScenePostImportPlugin.xml @@ -11,91 +11,91 @@ - + Override to add general import options. These will appear in the main import dock on the editor. Add options via [method add_import_option] and [method add_import_option_advanced]. - + Override to add internal import options. These will appear in the 3D scene import dialog. Add options via [method add_import_option] and [method add_import_option_advanced]. - - + + Return true whether updating the 3D view of the import dialog needs to be updated if an option has changed. - - - + + + Return true or false whether a given option should be visible. Return null to ignore. - - - + + + Return true or false whether a given option should be visible. Return null to ignore. - - - - + + + + Process a specific node or resource for a given category. - + Post process the scene. This function is called after the final scene has been configured. - + Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made. - - + + Add a specific import option (name and default value only). This function can only be called from [method _get_import_options] and [method _get_internal_import_options]. - - - - - - + + + + + + Add a specific import option. This function can only be called from [method _get_import_options] and [method _get_internal_import_options]. - + Query the value of an option. This function can only be called from those querying visibility, or processing. diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index 68ee939370..b39972694b 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -42,7 +42,7 @@ - + Adds [code]node[/code] as a child of the root node in the editor context. [b]Warning:[/b] The implementation of this method is currently disabled. diff --git a/doc/classes/EditorSelection.xml b/doc/classes/EditorSelection.xml index ff6f5f9206..9c3e87ddb0 100644 --- a/doc/classes/EditorSelection.xml +++ b/doc/classes/EditorSelection.xml @@ -12,7 +12,7 @@ - + Adds a node to the selection. [b]Note:[/b] The newly selected node will not be automatically edited in the inspector. If you want to edit a node, use [method EditorInterface.edit_node]. @@ -38,7 +38,7 @@ - + Removes a node from the selection. diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index ade7bc1256..2362213109 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -32,7 +32,7 @@ - + Adds a custom property info to a property. The dictionary must contain: - [code]name[/code]: [String] (the name of the property) @@ -72,14 +72,14 @@ - + Checks if any settings with the prefix [code]setting_prefix[/code] exist in the set of changed settings. See also [method get_changed_settings]. - + Erases the setting whose name is specified by [code]property[/code]. @@ -98,9 +98,9 @@ - - - + + + Returns project-specific metadata for the [code]section[/code] and [code]key[/code] specified. If the metadata doesn't exist, [code]default[/code] will be returned instead. See also [method set_project_metadata]. @@ -113,83 +113,83 @@ - + Returns the value of the setting specified by [code]name[/code]. This is equivalent to using [method Object.get] on the EditorSettings instance. - + Returns [code]true[/code] if the setting specified by [code]name[/code] exists, [code]false[/code] otherwise. - + Marks the passed editor setting as being changed, see [method get_changed_settings]. Only settings which exist (see [method has_setting]) will be accepted. - + Returns [code]true[/code] if the setting specified by [code]name[/code] can have its value reverted to the default value, [code]false[/code] otherwise. When this method returns [code]true[/code], a Revert button will display next to the setting in the Editor Settings. - + Returns the default value of the setting specified by [code]name[/code]. This is the value that would be applied when clicking the Revert button in the Editor Settings. - - + + Overrides the built-in editor action [code]name[/code] with the input actions defined in [code]actions_list[/code]. - + Sets the list of favorite files and directories for this project. - - - + + + Sets the initial value of the setting specified by [code]name[/code] to [code]value[/code]. This is used to provide a value for the Revert button in the Editor Settings. If [code]update_current[/code] is true, the current value of the setting will be set to [code]value[/code] as well. - - - + + + Sets project-specific metadata with the [code]section[/code], [code]key[/code] and [code]data[/code] specified. This metadata is stored outside the project folder and therefore won't be checked into version control. See also [method get_project_metadata]. - + Sets the list of recently visited folders in the file dialog for this project. - - + + Sets the [code]value[/code] of the setting specified by [code]name[/code]. This is equivalent to using [method Object.set] on the EditorSettings instance. diff --git a/doc/classes/EditorTranslationParserPlugin.xml b/doc/classes/EditorTranslationParserPlugin.xml index 84a671a93c..bbae06899c 100644 --- a/doc/classes/EditorTranslationParserPlugin.xml +++ b/doc/classes/EditorTranslationParserPlugin.xml @@ -111,9 +111,9 @@ - - - + + + Override this method to define a custom parsing logic to extract the translatable strings. diff --git a/doc/classes/EditorVCSInterface.xml b/doc/classes/EditorVCSInterface.xml index 0215d81a4e..cc75861130 100644 --- a/doc/classes/EditorVCSInterface.xml +++ b/doc/classes/EditorVCSInterface.xml @@ -11,14 +11,14 @@ - + Creates a version commit if the addon is initialized, else returns without doing anything. Uses the files which have been staged previously, with the commit message set to a value as provided as in the argument. - + Returns an [Array] of [Dictionary] objects containing the diff output from the VCS in use, if a VCS addon is initialized, else returns an empty [Array] object. The diff contents also consist of some contextual lines which provide context to the observed line change in the file. Each [Dictionary] object has the line diff contents under the keys: @@ -56,7 +56,7 @@ - + Initializes the VCS addon if not already. Uses the argument value as the path to the working directory of the project. Creates the initial commit if required. Returns [code]true[/code] if no failure occurs, else returns [code]false[/code]. @@ -81,14 +81,14 @@ - + Stages the file which should be committed when [method EditorVCSInterface.commit] is called. Argument should contain the absolute path. - + Unstages the file which was staged previously to be committed, so that it is no longer committed when [method EditorVCSInterface.commit] is called. Argument should contain the absolute path. diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 36dfee833b..a54997b52b 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -96,7 +96,7 @@ - + @@ -107,7 +107,7 @@ - + Returns a global singleton with given [code]name[/code]. Often used for plugins, e.g. GodotPayments. @@ -159,7 +159,7 @@ - + Returns [code]true[/code] if a singleton with given [code]name[/code] exists in global scope. @@ -186,20 +186,20 @@ - + - - + + - + diff --git a/doc/classes/EngineDebugger.xml b/doc/classes/EngineDebugger.xml index cd502dce81..c3e76b8cad 100644 --- a/doc/classes/EngineDebugger.xml +++ b/doc/classes/EngineDebugger.xml @@ -11,14 +11,14 @@ - + Returns [code]true[/code] if a capture with the given name is present otherwise [code]false[/code]. - + Returns [code]true[/code] if a profiler with the given name is present otherwise [code]false[/code]. @@ -31,32 +31,32 @@ - + Returns [code]true[/code] if a profiler with the given name is present and active otherwise [code]false[/code]. - - + + Calls the [code]add[/code] callable of the profiler with given [code]name[/code] and [code]data[/code]. - - - + + + Calls the [code]toggle[/code] callable of the profiler with given [code]name[/code] and [code]arguments[/code]. Enables/Disables the same profiler depending on [code]enable[/code] argument. - - + + Registers a message capture with given [code]name[/code]. If [code]name[/code] is "my_message" then messages starting with "my_message:" will be called with the given callable. Callable must accept a message string and a data array as argument. If the message and data are valid then callable must return [code]true[/code] otherwise [code]false[/code]. @@ -64,30 +64,30 @@ - - + + Registers a profiler with the given [code]name[/code]. See [EngineProfiler] for more information. - - + + Sends a message with given [code]message[/code] and [code]data[/code] array. - + Unregisters the message capture with given [code]name[/code]. - + Unregisters a profiler with given [code]name[/code]. diff --git a/doc/classes/EngineProfiler.xml b/doc/classes/EngineProfiler.xml index 752ecda867..d8fb193761 100644 --- a/doc/classes/EngineProfiler.xml +++ b/doc/classes/EngineProfiler.xml @@ -12,25 +12,25 @@ - + Called when data is added to profiler using [method EngineDebugger.profiler_add_frame_data]. - - - - + + + + Called once every engine iteration when the profiler is active with information about the current frame. All time values are in seconds. Lower values represent faster processing times and are therefore considered better. - - + + Called when the profiler is enabled/disabled, along with a set of [code]options[/code]. diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index f662a07825..fce12b3602 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -20,15 +20,15 @@ - + Returns the intensity of the glow level [code]idx[/code]. - - + + Sets the intensity of the glow level [code]idx[/code]. A value above [code]0.0[/code] enables the level. Each level relies on the previous level. This means that enabling higher glow levels will slow down the glow effect rendering, even if previous levels aren't enabled. diff --git a/doc/classes/Expression.xml b/doc/classes/Expression.xml index 50979c9b68..130f2f2272 100644 --- a/doc/classes/Expression.xml +++ b/doc/classes/Expression.xml @@ -53,10 +53,10 @@ - - - - + + + + Executes the expression that was previously parsed by [method parse] and returns the result. Before you use the returned object, you should check if the method failed by calling [method has_execute_failed]. If you defined input variables in [method parse], you can specify their values in the inputs array, in the same order. @@ -76,8 +76,8 @@ - - + + Parses the expression and returns an [enum Error] code. You can optionally specify names of variables that may appear in the expression with [code]input_names[/code], so that you can bind them when it gets executed. diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 3a2776ff21..0c6310c09f 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -76,7 +76,7 @@ - + Returns [code]true[/code] if the file exists in the given path. [b]Note:[/b] Many resources types are imported (e.g. textures or sound files), and their source asset will not be included in the exported game, as only the imported version is used. See [method ResourceLoader.exists] for an alternative approach that takes resource remapping into account. @@ -115,7 +115,7 @@ - + Returns the whole file as a [String]. Text is interpreted as being UTF-8 encoded. If [code]skip_cr[/code] is [code]true[/code], carriage return characters ([code]\r[/code], CR) will be ignored when parsing the UTF-8, so that only line feed characters ([code]\n[/code], LF) represent a new line (Unix convention). @@ -123,14 +123,14 @@ - + Returns next [code]length[/code] bytes of the file as a [PackedByteArray]. - + Returns the next value of the file in 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, and cannot be a double quotation mark. Text is interpreted as being UTF-8 encoded. Text values must be enclosed in double quotes if they include the delimiter character. Double quotes within a text value can be escaped by doubling their occurrence. @@ -176,14 +176,14 @@ - + Returns an MD5 String representing the file at the given path or an empty [String] on failure. - + Returns the last time the [code]file[/code] was modified in Unix timestamp format or returns a [String] "ERROR IN [code]file[/code]". This Unix timestamp can be converted to another format using the [Time] singleton. @@ -221,14 +221,14 @@ - + Returns a SHA-256 [String] representing the file at the given path or an empty [String] on failure. - + Returns the next [Variant] value from the file. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. @@ -242,17 +242,17 @@ - - + + Opens the file for writing or reading, depending on the flags. - - - + + + Opens a compressed file for reading or writing. [b]Note:[/b] [method open_compressed] can only read files that were saved by Godot, not third-party compression formats. See [url=https://github.com/godotengine/godot/issues/28999]GitHub issue #28999[/url] for a workaround. @@ -260,9 +260,9 @@ - - - + + + Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. [b]Note:[/b] The provided key must be 32 bytes long. @@ -270,23 +270,23 @@ - - - + + + Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. - + Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file). - + Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). [b]Note:[/b] This is an offset, so you should use negative numbers or the cursor will be at the end of the file. @@ -294,7 +294,7 @@ - + Stores an integer as 16 bits in the file. [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 2^16 - 1][/code]. Any other value will overflow and wrap around. @@ -337,7 +337,7 @@ - + Stores an integer as 32 bits in the file. [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 2^32 - 1][/code]. Any other value will overflow and wrap around. @@ -346,7 +346,7 @@ - + Stores an integer as 64 bits in the file. [b]Note:[/b] The [code]value[/code] must lie in the interval [code][-2^63, 2^63 - 1][/code] (i.e. be a valid [int] value). @@ -354,7 +354,7 @@ - + Stores an integer as 8 bits in the file. [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 255][/code]. Any other value will overflow and wrap around. @@ -363,15 +363,15 @@ - + Stores the given array of bytes in the file. - - + + 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. @@ -379,28 +379,28 @@ - + Stores a floating-point number as 64 bits in the file. - + Stores a floating-point number as 32 bits in the file. - + Appends [code]line[/code] to the file followed by a line return character ([code]\n[/code]), encoding the text as UTF-8. - + Stores the given [String] as a line in the file in Pascal format (i.e. also store the length of the string). Text will be encoded as UTF-8. @@ -408,14 +408,14 @@ - + Stores a floating-point number in the file. - + Appends [code]string[/code] to the file without a line return, encoding the text as UTF-8. [b]Note:[/b] This method is intended to be used to write text files. The string is stored as a UTF-8 encoded buffer without string length or terminating zero, which means that it can't be loaded back easily. If you want to store a retrievable string in a binary file, consider using [method store_pascal_string] instead. For retrieving strings from a text file, you can use [code]get_buffer(length).get_string_from_utf8()[/code] (if you know the length) or [method get_as_text]. @@ -423,8 +423,8 @@ - - + + Stores any Variant value in the file. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code). [b]Note:[/b] Not all properties are included. Only properties that are configured with the [constant PROPERTY_USAGE_STORAGE] flag set will be serialized. You can add a new usage flag to a property by overriding the [method Object._get_property_list] method in your class. You can also check how property usage is configured by calling [method Object._get_property_list]. See [enum PropertyUsageFlags] for the possible usage flags. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index f45031cea8..00a1028c5e 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -11,8 +11,8 @@ - - + + Adds a comma-delimited file name [code]filter[/code] option to the [FileDialog] with an optional [code]description[/code], which restricts what files can be picked. A [code]filter[/code] should be of the form [code]"filename.extension"[/code], where filename and extension can be [code]*[/code] to match any string. Filters starting with [code].[/code] (i.e. empty filenames) are not allowed. @@ -86,19 +86,19 @@ - + Emitted when the user selects a directory. - + Emitted when the user selects a file by double-clicking it or pressing the [b]OK[/b] button. - + Emitted when the user selects multiple files. diff --git a/doc/classes/FileSystemDock.xml b/doc/classes/FileSystemDock.xml index 31299deb7d..22048c6761 100644 --- a/doc/classes/FileSystemDock.xml +++ b/doc/classes/FileSystemDock.xml @@ -9,7 +9,7 @@ - + @@ -20,34 +20,34 @@ - + - - + + - - + + - + - + - + diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index ec2776f636..9e9c592400 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -11,11 +11,11 @@ - - - - - + + + + + Draw a single Unicode character [code]char[/code] into a canvas item using the font, at a given position, with [code]modulate[/code] color. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. [b]Note:[/b] Do not use this function to draw strings character by character, use [method draw_string] or [TextLine] instead. @@ -23,12 +23,12 @@ - - - - - - + + + + + + Draw a single Unicode character [code]char[/code] outline into a canvas item using the font, at a given position, with [code]modulate[/code] color and [code]size[/code] outline size. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. [b]Note:[/b] Do not use this function to draw strings character by character, use [method draw_string] or [TextLine] instead. @@ -36,18 +36,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + Breaks [code]text[/code] to the lines using rules specified by [code]flags[/code] and draws it into a canvas item using the font, at a given position, with [code]modulate[/code] color, optionally clipping the width and aligning horizontally. [code]position[/code] specifies the baseline of the first line, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. See also [method CanvasItem.draw_multiline_string]. @@ -55,19 +55,19 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + Breaks [code]text[/code] to the lines using rules specified by [code]flags[/code] and draws text outline into a canvas item using the font, at a given position, with [code]modulate[/code] color and [code]size[/code] outline size, optionally clipping the width and aligning horizontally. [code]position[/code] specifies the baseline of the first line, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. See also [method CanvasItem.draw_multiline_string_outline]. @@ -75,16 +75,16 @@ - - - - - - - - - - + + + + + + + + + + Draw [code]text[/code] into a canvas item using the font, at a given position, with [code]modulate[/code] color, optionally clipping the width and aligning horizontally. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. See also [method CanvasItem.draw_string]. @@ -92,17 +92,17 @@ - - - - - - - - - - - + + + + + + + + + + + Draw [code]text[/code] outline into a canvas item using the font, at a given position, with [code]modulate[/code] color and [code]size[/code] outline size, optionally clipping the width and aligning horizontally. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. See also [method CanvasItem.draw_string_outline]. @@ -110,17 +110,17 @@ - - - - + + + + Returns [TextServer] RID of the font cache for specific variation. - + Returns the average font ascent (number of pixels above the baseline). [b]Note:[/b] Real ascent of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the ascent of empty line). @@ -128,8 +128,8 @@ - - + + Returns the size of a character, optionally taking kerning into account if the next character is provided. [b]Note:[/b] Do not use this function to calculate width of the string character by character, use [method get_string_size] or [TextLine] instead. The height returned is the font height (see also [method get_height]) and has no relation to the glyph height. @@ -137,7 +137,7 @@ - + Returns the average font descent (number of pixels below the baseline). [b]Note:[/b] Real descent of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the descent of empty line). @@ -175,7 +175,7 @@ - + Returns the total average font height (ascent plus descent) in pixels. [b]Note:[/b] Real height of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the height of empty line). @@ -183,15 +183,15 @@ - - - - - - - - - + + + + + + + + + Returns the size of a bounding box of a string broken into the lines, taking kerning and advance into account. See also [method draw_multiline_string]. @@ -211,20 +211,20 @@ - + Returns the spacing for the given [code]type[/code] (see [enum TextServer.SpacingType]). - - - - - - - + + + + + + + Returns the size of a bounding box of a single-line string, taking kerning and advance into account. See also [method get_multiline_string_size] and [method draw_string]. For example, to get the string size as displayed by a single-line Label, use: @@ -256,7 +256,7 @@ - + Returns average pixel offset of the underline below the baseline. [b]Note:[/b] Real underline position of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate. @@ -264,7 +264,7 @@ - + Returns average thickness of the underline. [b]Note:[/b] Real underline thickness of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate. @@ -272,36 +272,36 @@ - + Returns [code]true[/code] if a Unicode [code]char[/code] is available in the font. - + Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). - + Returns [code]true[/code], if font supports given script ([url=https://en.wikipedia.org/wiki/ISO_15924]ISO 15924[/url] code). - - + + Sets LRU cache capacity for [code]draw_*[/code] methods. - + Sets array of fallback [Font]s. diff --git a/doc/classes/FontFile.xml b/doc/classes/FontFile.xml index dc2cbdde63..622bb17e59 100644 --- a/doc/classes/FontFile.xml +++ b/doc/classes/FontFile.xml @@ -39,8 +39,8 @@ - - + + Removes all rendered glyphs information from the cache entry. [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method remove_texture] to remove them manually. @@ -48,23 +48,23 @@ - - + + Removes all kerning overrides. - + Removes all font sizes from the cache entry - - + + Removes all textures from font cache entry. [b]Note:[/b] This function will not remove glyphs associated with the texture, use [method remove_glyph] to remove them manually. @@ -72,8 +72,8 @@ - - + + Returns the font ascent (number of pixels above the baseline). @@ -86,51 +86,51 @@ - - + + - - + + - - + + - - + + - + Returns embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. - + Recturns an active face index in the TrueType / OpenType collection. - - - + + + Returns glyph advance (offset of the next glyph). [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. @@ -138,77 +138,77 @@ - - - + + + Returns the glyph index of a [code]char[/code], optionally modified by the [code]variation_selector[/code]. - - + + Returns list of rendered glyphs in the cache entry. - - - + + + Returns glyph offset from the baseline. - - - + + + Returns glyph size. - - - + + + Returns index of the cache texture containing the glyph. - - - + + + Returns rectangle in the cache texture containing the glyph. - - - + + + Returns kerning for the pair of glyphs. - - + + Returns list of the kerning overrides. - + Returns [code]true[/code] if support override is enabled for the [code]language[/code]. @@ -221,7 +221,7 @@ - + Returns [code]true[/code] if support override is enabled for the [code]script[/code]. @@ -234,54 +234,54 @@ - + Returns list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size. - - + + Returns number of textures used by font cache entry. - - - + + + Returns a copy of the font cache texture image. - - - + + + Returns a copy of the array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. - + Returns 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. - + Returns variation coordinates for the specified font cache entry. See [method Font.get_supported_variation_list] for more info. - + Loads an AngelCode BMFont (.fnt, .font) bitmap font from file [code]path[/code]. [b]Warning:[/b] This method should only be used in the editor or in cases when you need to load external fonts at run-time, such as fonts located at the [code]user://[/code] directory. @@ -289,7 +289,7 @@ - + Loads a TrueType (.ttf), OpenType (.otf), WOFF (.woff), WOFF2 (.woff2) or Type 1 (.pfb, .pfm) dynamic font from file [code]path[/code]. [b]Warning:[/b] This method should only be used in the editor or in cases when you need to load external fonts at run-time, such as fonts located at the [code]user://[/code] directory. @@ -297,16 +297,16 @@ - + Removes specified font cache entry. - - - + + + Removes specified rendered glyph information from the cache entry. [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method remove_texture] to remove them manually. @@ -314,40 +314,40 @@ - - - + + + Removes kerning override for the pair of glyphs. - + Remove language support override. - + Removes script support override. - - + + Removes specified font size from the cache entry. - - - + + + Removes specified texture from the cache entry. [b]Note:[/b] This function will not remove glyphs associated with the texture. Remove them manually using [method remove_glyph]. @@ -355,85 +355,85 @@ - - - + + + Renders specified glyph to the font cache texture. - - - - + + + + Renders the range of characters to the font cache texture. - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - + + Sets embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. - - + + Sets an active face index in the TrueType / OpenType collection. - - - - + + + + Sets glyph advance (offset of the next glyph). [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. @@ -441,102 +441,102 @@ - - - - + + + + Sets glyph offset from the baseline. - - - - + + + + Sets glyph size. - - - - + + + + Sets index of the cache texture containing the glyph. - - - - + + + + Sets rectangle in the cache texture containing the glyph. - - - - + + + + Sets kerning for the pair of glyphs. - - + + Adds override for [method Font.is_language_supported]. - - + + Adds override for [method Font.is_script_supported]. - - - - + + + + Sets font cache texture image. - - - - + + + + Sets array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty (for the fonts without dynamic glyph generation support). - - + + Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. - - + + Sets variation coordinates for the specified font cache entry. See [method Font.get_supported_variation_list] for more info. diff --git a/doc/classes/FontVariation.xml b/doc/classes/FontVariation.xml index a1b96fb137..30cb732751 100644 --- a/doc/classes/FontVariation.xml +++ b/doc/classes/FontVariation.xml @@ -29,8 +29,8 @@ - - + + Sets the spacing for [code]type[/code] (see [enum TextServer.SpacingType]) to [code]value[/code] in pixels (not relative to the font size). diff --git a/doc/classes/GPUParticles2D.xml b/doc/classes/GPUParticles2D.xml index e60ab094c6..7c2966bd4f 100644 --- a/doc/classes/GPUParticles2D.xml +++ b/doc/classes/GPUParticles2D.xml @@ -20,11 +20,11 @@ - - - - - + + + + + Emits a single particle. Whether [code]xform[/code], [code]velocity[/code], [code]color[/code] and [code]custom[/code] are applied depends on the value of [code]flags[/code]. See [enum EmitFlags]. diff --git a/doc/classes/GPUParticles3D.xml b/doc/classes/GPUParticles3D.xml index b415c56154..4cd95f561f 100644 --- a/doc/classes/GPUParticles3D.xml +++ b/doc/classes/GPUParticles3D.xml @@ -20,18 +20,18 @@ - - - - - + + + + + Emits a single particle. Whether [code]xform[/code], [code]velocity[/code], [code]color[/code] and [code]custom[/code] are applied depends on the value of [code]flags[/code]. See [enum EmitFlags]. - + Returns the [Mesh] that is drawn at index [code]pass[/code]. @@ -44,8 +44,8 @@ - - + + Sets the [Mesh] that is drawn at index [code]pass[/code]. diff --git a/doc/classes/GPUParticlesCollisionSDF3D.xml b/doc/classes/GPUParticlesCollisionSDF3D.xml index bc8b3c7c11..1a530b2561 100644 --- a/doc/classes/GPUParticlesCollisionSDF3D.xml +++ b/doc/classes/GPUParticlesCollisionSDF3D.xml @@ -16,15 +16,15 @@ - + Returns whether or not the specified layer of the [member bake_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member bake_mask], given a [code]layer_number[/code] between 1 and 32. diff --git a/doc/classes/Generic6DOFJoint3D.xml b/doc/classes/Generic6DOFJoint3D.xml index b1bc411a21..5eec089a6f 100644 --- a/doc/classes/Generic6DOFJoint3D.xml +++ b/doc/classes/Generic6DOFJoint3D.xml @@ -11,79 +11,79 @@ - + - + - + - + - + - + - - + + - - + + - - + + - - + + - - + + - - + + diff --git a/doc/classes/Geometry2D.xml b/doc/classes/Geometry2D.xml index a4cfa1ddff..0926f0acfe 100644 --- a/doc/classes/Geometry2D.xml +++ b/doc/classes/Geometry2D.xml @@ -11,8 +11,8 @@ - - + + 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]. If [code]polygon_b[/code] is enclosed by [code]polygon_a[/code], returns an outer polygon (boundary) and inner polygon (hole) which could be distinguished by calling [method is_polygon_clockwise]. @@ -20,23 +20,23 @@ - - + + 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. - - + + Mutually excludes common area defined by intersection of [code]polygon_a[/code] and [code]polygon_b[/code] (see [method intersect_polygons]) and returns an array of excluded polygons. This performs [constant OPERATION_XOR] between polygons. In other words, returns all but common area between polygons. The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise]. @@ -44,36 +44,36 @@ - - - + + + Returns the 2D point on the 2D segment ([code]s1[/code], [code]s2[/code]) that is closest to [code]point[/code]. The returned point will always be inside the specified segment. - - - + + + Returns the 2D point on the 2D line defined by ([code]s1[/code], [code]s2[/code]) that is closest to [code]point[/code]. The returned point can be inside the segment ([code]s1[/code], [code]s2[/code]) or outside of it, i.e. somewhere on the line extending from the segment. - - - - + + + + Given the two 2D segments ([code]p1[/code], [code]q1[/code]) and ([code]p2[/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]q1[/code]) as well the accompanying point on ([code]p2[/code], [code]q2[/code]). - - + + 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. The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise]. @@ -81,42 +81,42 @@ - - + + 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. - - - + + + Returns [code]true[/code] if [code]point[/code] is inside the circle or if it's located exactly [i]on[/i] the circle's boundary, otherwise returns [code]false[/code]. - - + + 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]. - + Returns [code]true[/code] if [code]polygon[/code]'s vertices are ordered in clockwise order, otherwise returns [code]false[/code]. - - - - + + + + Checks if the two lines ([code]from_a[/code], [code]dir_a[/code]) and ([code]from_b[/code], [code]dir_b[/code]) intersect. If yes, return the point of intersection as [Vector2]. If no intersection takes place, returns [code]null[/code]. [b]Note:[/b] The lines are specified using direction vectors, not end points. @@ -124,15 +124,15 @@ - + Given an array of [Vector2]s representing tiles, builds an atlas. The returned dictionary has two keys: [code]points[/code] is an array of [Vector2] that specifies the positions of each tile, [code]size[/code] contains the overall size of the whole atlas as [Vector2]. - - + + 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. The operation may result in an outer polygon (boundary) and multiple inner polygons (holes) produced which could be distinguished by calling [method is_polygon_clockwise]. @@ -140,9 +140,9 @@ - - - + + + Inflates or deflates [code]polygon[/code] by [code]delta[/code] units (pixels). If [code]delta[/code] is positive, makes the polygon grow outward. If [code]delta[/code] is negative, shrinks the polygon inward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. Returns an empty array if [code]delta[/code] is negative and the absolute value of it approximately exceeds the minimum bounding rectangle dimensions of the polygon. Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum PolyJoinType]. @@ -167,10 +167,10 @@ - - - - + + + + Inflates or deflates [code]polyline[/code] by [code]delta[/code] units (pixels), producing polygons. If [code]delta[/code] is positive, makes the polyline grow outward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. If [code]delta[/code] is negative, returns an empty array. Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum PolyJoinType]. @@ -180,44 +180,44 @@ - - - - + + + + Returns if [code]point[/code] is inside the triangle specified by [code]a[/code], [code]b[/code] and [code]c[/code]. - - - - + + + + Given the 2D segment ([code]segment_from[/code], [code]segment_to[/code]), returns the position on the segment (as a number between 0 and 1) at which the segment hits the circle that is located at position [code]circle_position[/code] and has radius [code]circle_radius[/code]. If the segment does not intersect the circle, -1 is returned (this is also the case if the line extending the segment would intersect the circle, but the segment does not). - - - - + + + + Checks if the two segments ([code]from_a[/code], [code]to_a[/code]) and ([code]from_b[/code], [code]to_b[/code]) intersect. If yes, return the point of intersection as [Vector2]. If no intersection takes place, returns [code]null[/code]. - + Triangulates the area specified by discrete set of [code]points[/code] such that no point is inside the circumcircle of any resulting triangle. Returns a [PackedInt32Array] where each triangle consists of three consecutive point indices into [code]points[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PackedInt32Array] is returned. - + Triangulates the polygon specified by the points in [code]polygon[/code]. Returns a [PackedInt32Array] where each triangle consists of three consecutive point indices into [code]polygon[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). Output triangles will always be counter clockwise, and the contour will be flipped if it's clockwise. If the triangulation did not succeed, an empty [PackedInt32Array] is returned. diff --git a/doc/classes/Geometry3D.xml b/doc/classes/Geometry3D.xml index c05d7df53f..654c499c97 100644 --- a/doc/classes/Geometry3D.xml +++ b/doc/classes/Geometry3D.xml @@ -11,115 +11,115 @@ - + Returns an array with 6 [Plane]s that describe the sides of a box centered at the origin. The box size is defined by [code]extents[/code], which represents one (positive) corner of the box (i.e. half its actual size). - - - - - + + + + + Returns an array of [Plane]s closely bounding a faceted capsule centered at the origin with radius [code]radius[/code] and height [code]height[/code]. The parameter [code]sides[/code] defines how many planes will be generated for the side part of the capsule, whereas [code]lats[/code] gives the number of latitudinal steps at the bottom and top of the capsule. The parameter [code]axis[/code] describes the axis along which the capsule is oriented (0 for X, 1 for Y, 2 for Z). - - - - + + + + Returns an array of [Plane]s closely bounding a faceted cylinder centered at the origin with radius [code]radius[/code] and height [code]height[/code]. The parameter [code]sides[/code] defines how many planes will be generated for the round part of the cylinder. The parameter [code]axis[/code] describes the axis along which the cylinder is oriented (0 for X, 1 for Y, 2 for Z). - - + + Clips the polygon defined by the points in [code]points[/code] against the [code]plane[/code] and returns the points of the clipped polygon. - - - + + + Returns the 3D point on the 3D segment ([code]s1[/code], [code]s2[/code]) that is closest to [code]point[/code]. The returned point will always be inside the specified segment. - - - + + + Returns the 3D point on the 3D line defined by ([code]s1[/code], [code]s2[/code]) that is closest to [code]point[/code]. The returned point can be inside the segment ([code]s1[/code], [code]s2[/code]) or outside of it, i.e. somewhere on the line extending from the segment. - - - - + + + + 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]). - - - - - + + + + + Tests if the 3D ray starting at [code]from[/code] with the direction of [code]dir[/code] intersects the triangle specified by [code]a[/code], [code]b[/code] and [code]c[/code]. If yes, returns the point of intersection as [Vector3]. If no intersection takes place, returns [code]null[/code]. - - - + + + 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. Otherwise, returns an empty array. - - - - + + + + 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. - - - - + + + + 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. - - - - - + + + + + Tests if the segment ([code]from[/code], [code]to[/code]) intersects the triangle [code]a[/code], [code]b[/code], [code]c[/code]. If yes, returns the point of intersection as [Vector3]. If no intersection takes place, returns [code]null[/code]. diff --git a/doc/classes/GeometryInstance3D.xml b/doc/classes/GeometryInstance3D.xml index 365efa6761..79a60a9e62 100644 --- a/doc/classes/GeometryInstance3D.xml +++ b/doc/classes/GeometryInstance3D.xml @@ -11,21 +11,21 @@ - + - + Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero. - - + + diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml index 8c5373216a..bf64feedda 100644 --- a/doc/classes/Gradient.xml +++ b/doc/classes/Gradient.xml @@ -12,22 +12,22 @@ - - + + Adds the specified color to the end of the gradient, with the specified offset. - + Returns the color of the gradient color at index [code]point[/code]. - + Returns the offset of the gradient color at index [code]point[/code]. @@ -40,14 +40,14 @@ - + Returns the interpolated color specified by [code]offset[/code]. - + Removes the color at the index [code]point[/code]. @@ -60,16 +60,16 @@ - - + + Sets the color of the gradient color at index [code]point[/code]. - - + + Sets the offset for the gradient color at index [code]point[/code]. diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 33145dccd0..d257e990f7 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -12,17 +12,17 @@ - - + + Virtual method which can be overridden to customize how connections are drawn. - - - + + + Returns whether the [code]mouse_position[/code] is in the input hot zone. By default, a hot zone is a [Rect2] positioned such that its center is at [code]graph_node[/code].[method GraphNode.get_connection_input_position]([code]slot_index[/code]) (For output's case, call [method GraphNode.get_connection_output_position] instead). The hot zone's width is twice the Theme Property [code]port_grab_distance_horizontal[/code], and its height is twice the [code]port_grab_distance_vertical[/code]. @@ -39,9 +39,9 @@ - - - + + + Returns whether the [code]mouse_position[/code] is in the output hot zone. For more information on hot zones, see [method _is_in_input_hotzone]. Below is a sample code to help get started: @@ -57,10 +57,10 @@ - - - - + + + + This virtual method can be used to insert additional error detection while the user is dragging a connection over a valid port. Return [code]true[/code] if the connection is indeed valid or return [code]false[/code] if the connection is impossible. If the connection is impossible, no snapping to the port and thus no connection request to that port will happen. @@ -80,22 +80,22 @@ - - + + Makes possible the connection between two different slot types. The type is defined with the [method GraphNode.set_slot] method. - + Makes possible to disconnect nodes when dragging from the slot at the left if it has the specified type. - + Makes possible to disconnect nodes when dragging from the slot at the right if it has the specified type. @@ -114,20 +114,20 @@ - - - - + + + + Create a connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection already exists, no connection is created. - - - - + + + + Removes the connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection does not exist, no connection is removed. @@ -142,8 +142,8 @@ - - + + Returns the points which would make up a connection between [code]from[/code] and [code]to[/code]. @@ -163,58 +163,58 @@ - - - - + + + + Returns [code]true[/code] if the [code]from_port[/code] slot of the [code]from[/code] GraphNode is connected to the [code]to_port[/code] slot of the [code]to[/code] GraphNode. - - + + Returns whether it's possible to connect slots of the specified types. - - + + Makes it not possible to connect between two different slot types. The type is defined with the [method GraphNode.set_slot] method. - + Removes the possibility to disconnect nodes when dragging from the slot at the left if it has the specified type. - + Removes the possibility to disconnect nodes when dragging from the slot at the right if it has the specified type. - - - - - + + + + + Sets the coloration of the connection between [code]from[/code]'s [code]from_port[/code] and [code]to[/code]'s [code]to_port[/code] with the color provided in the [theme_item activity] theme property. - + Sets the specified [code]node[/code] as the one selected. @@ -284,34 +284,34 @@ - - - + + + Emitted at the beginning of a connection drag. - - - + + + Emitted when user dragging connection from input port into empty space of the graph. - - - - + + + + Emitted to the GraphEdit when the connection between the [code]from_slot[/code] slot of the [code]from[/code] GraphNode and the [code]to_slot[/code] slot of the [code]to[/code] GraphNode is attempted to be created. - - - + + + Emitted when user dragging connection from output port into empty space of the graph. @@ -322,16 +322,16 @@ - + Emitted when a GraphNode is attempted to be removed from the GraphEdit. Provides a list of node names to be removed (all selected nodes, excluding nodes without closing button). - - - - + + + + Emitted to the GraphEdit when the connection between [code]from_slot[/code] slot of [code]from[/code] GraphNode and [code]to_slot[/code] slot of [code]to[/code] GraphNode is attempted to be removed. @@ -347,12 +347,12 @@ - + - + Emitted when a GraphNode is selected. @@ -363,13 +363,13 @@ - + Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. [code]position[/code] is the position of the mouse pointer when the signal is sent. - + Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code. diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index 36dbae1d74..ac14d5d2a8 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -19,14 +19,14 @@ - + Disables input and output slot whose index is [code]idx[/code]. - + Returns the [Color] of the input connection [code]idx[/code]. @@ -39,28 +39,28 @@ - + Returns the height of the input connection [code]idx[/code]. - + Returns the position of the input connection [code]idx[/code]. - + Returns the type of the input connection [code]idx[/code]. - + Returns the [Color] of the output connection [code]idx[/code]. @@ -73,86 +73,86 @@ - + Returns the height of the output connection [code]idx[/code]. - + Returns the position of the output connection [code]idx[/code]. - + Returns the type of the output connection [code]idx[/code]. - + Returns the left (input) [Color] of the slot [code]idx[/code]. - + Returns the right (output) [Color] of the slot [code]idx[/code]. - + Returns the left (input) type of the slot [code]idx[/code]. - + Returns the right (output) type of the slot [code]idx[/code]. - + Returns true if the background [StyleBox] of the slot [code]idx[/code] is drawn. - + Returns [code]true[/code] if left (input) side of the slot [code]idx[/code] is enabled. - + Returns [code]true[/code] if right (output) side of the slot [code]idx[/code] is enabled. - - - - - - - - - - + + + + + + + + + + Sets properties of the slot with ID [code]idx[/code]. If [code]enable_left[/code]/[code]right[/code], a port will appear and the slot will be able to be connected from this side. @@ -165,56 +165,56 @@ - - + + Sets the [Color] of the left (input) side of the slot [code]idx[/code] to [code]color_left[/code]. - - + + Sets the [Color] of the right (output) side of the slot [code]idx[/code] to [code]color_right[/code]. - - + + Toggles the background [StyleBox] of the slot [code]idx[/code]. - - + + Toggles the left (input) side of the slot [code]idx[/code]. If [code]enable_left[/code] is [code]true[/code], a port will appear on the left side and the slot will be able to be connected from this side. - - + + Toggles the right (output) side of the slot [code]idx[/code]. If [code]enable_right[/code] is [code]true[/code], a port will appear on the right side and the slot will be able to be connected from this side. - - + + Sets the left (input) type of the slot [code]idx[/code] to [code]type_left[/code]. - - + + Sets the right (output) type of the slot [code]idx[/code] to [code]type_right[/code]. @@ -260,8 +260,8 @@ - - + + Emitted when the GraphNode is dragged. @@ -277,13 +277,13 @@ - + Emitted when the GraphNode is requested to be resized. Happens on dragging the resizer handle (see [member resizable]). - + Emitted when any GraphNode's slot is updated. diff --git a/doc/classes/HMACContext.xml b/doc/classes/HMACContext.xml index f2b946cab7..d033738e52 100644 --- a/doc/classes/HMACContext.xml +++ b/doc/classes/HMACContext.xml @@ -62,15 +62,15 @@ - - + + Initializes the HMACContext. This method cannot be called again on the same HMACContext until [method finish] has been called. - + Updates the message to be HMACed. This can be called multiple times before [method finish] is called to append [code]data[/code] to the message, but cannot be called until [method start] has been called. diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index fb437b6d8e..645f328be0 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -28,10 +28,10 @@ - - - - + + + + Connects to a host. This needs to be done before any requests are sent. The host should not have http:// prepended but will strip the protocol identifier if provided. @@ -97,7 +97,7 @@ - + Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: [codeblocks] @@ -135,10 +135,10 @@ - - - - + + + + Sends a request to the connected host. The URL parameter is usually just the part after the host, so for [code]https://somehost.com/index.php[/code], it is [code]/index.php[/code]. When sending requests to an HTTP proxy server, it should be an absolute URL. For [constant HTTPClient.METHOD_OPTIONS] requests, [code]*[/code] is also allowed. For [constant HTTPClient.METHOD_CONNECT] requests, it should be the authority component ([code]host:port[/code]). @@ -163,10 +163,10 @@ - - - - + + + + Sends a raw request to the connected host. The URL parameter is usually just the part after the host, so for [code]https://somehost.com/index.php[/code], it is [code]/index.php[/code]. When sending requests to an HTTP proxy server, it should be an absolute URL. For [constant HTTPClient.METHOD_OPTIONS] requests, [code]*[/code] is also allowed. For [constant HTTPClient.METHOD_CONNECT] requests, it should be the authority component ([code]host:port[/code]). @@ -176,8 +176,8 @@ - - + + Sets the proxy server for HTTP requests. The proxy server is unset if [code]host[/code] is empty or [code]port[/code] is -1. @@ -185,8 +185,8 @@ - - + + Sets the proxy server for HTTPS requests. The proxy server is unset if [code]host[/code] is empty or [code]port[/code] is -1. diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 3d2e9449e2..2307cf149d 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -187,11 +187,11 @@ - - - - - + + + + + Creates request on the underlying [HTTPClient]. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request]. Returns [constant OK] if request is successfully created. (Does not imply that the server has responded), [constant ERR_UNCONFIGURED] if not in the tree, [constant ERR_BUSY] if still processing previous request, [constant ERR_INVALID_PARAMETER] if given string is not a valid URL format, or [constant ERR_CANT_CONNECT] if not using thread and the [HTTPClient] cannot connect to host. @@ -201,11 +201,11 @@ - - - - - + + + + + Creates request on the underlying [HTTPClient] using a raw array of bytes for the request body. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request]. Returns [constant OK] if request is successfully created. (Does not imply that the server has responded), [constant ERR_UNCONFIGURED] if not in the tree, [constant ERR_BUSY] if still processing previous request, [constant ERR_INVALID_PARAMETER] if given string is not a valid URL format, or [constant ERR_CANT_CONNECT] if not using thread and the [HTTPClient] cannot connect to host. @@ -213,8 +213,8 @@ - - + + Sets the proxy server for HTTP requests. The proxy server is unset if [code]host[/code] is empty or [code]port[/code] is -1. @@ -222,8 +222,8 @@ - - + + Sets the proxy server for HTTPS requests. The proxy server is unset if [code]host[/code] is empty or [code]port[/code] is -1. @@ -259,10 +259,10 @@ - - - - + + + + Emitted when a request is completed. diff --git a/doc/classes/HashingContext.xml b/doc/classes/HashingContext.xml index c126efcfbb..ea973043db 100644 --- a/doc/classes/HashingContext.xml +++ b/doc/classes/HashingContext.xml @@ -69,14 +69,14 @@ - + Starts a new hash computation of the given [code]type[/code] (e.g. [constant HASH_SHA256] to start computation of a SHA-256). - + Updates the computation with the given [code]chunk[/code] of data. diff --git a/doc/classes/HingeJoint3D.xml b/doc/classes/HingeJoint3D.xml index eb1d1d5eca..d2547434e7 100644 --- a/doc/classes/HingeJoint3D.xml +++ b/doc/classes/HingeJoint3D.xml @@ -11,30 +11,30 @@ - + Returns the value of the specified flag. - + Returns the value of the specified parameter. - - + + If [code]true[/code], enables the specified flag. - - + + Sets the value of the specified parameter. diff --git a/doc/classes/IP.xml b/doc/classes/IP.xml index 569f7fe570..63de1f8081 100644 --- a/doc/classes/IP.xml +++ b/doc/classes/IP.xml @@ -11,14 +11,14 @@ - + Removes all of a [code]hostname[/code]'s cached references. If no [code]hostname[/code] is given, all cached IP addresses are removed. - + Removes a given item [code]id[/code] from the queue. This should be used to free a queue after it has completed to enable more queries to happen. @@ -46,45 +46,45 @@ - + Returns a queued hostname's IP address, given its queue [code]id[/code]. Returns an empty string on error or if resolution hasn't happened yet (see [method get_resolve_item_status]). - + Returns resolved addresses, or an empty array if an error happened or resolution didn't happen yet (see [method get_resolve_item_status]). - + Returns a queued hostname's status as a [enum ResolverStatus] constant, given its queue [code]id[/code]. - - + + Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the [enum Type] constant given as [code]ip_type[/code]. - - + + Resolves a given hostname in a blocking way. Addresses are returned as an [Array] of IPv4 or IPv6 addresses depending on [code]ip_type[/code]. - - + + Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the [enum Type] constant given as [code]ip_type[/code]. Returns the queue ID if successful, or [constant RESOLVER_INVALID_ID] on error. diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 754d1ae68a..94fb8fbb19 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -14,53 +14,53 @@ - - - + + + - - - + + + Alpha-blends [code]src_rect[/code] from [code]src[/code] image to this image at coordinates [code]dest[/code], clipped accordingly to both image bounds. This image and [code]src[/code] image [b]must[/b] have the same format. [code]src_rect[/code] with not positive size is treated as empty. - - - - + + + + Alpha-blends [code]src_rect[/code] from [code]src[/code] image to this image using [code]mask[/code] image at coordinates [code]dst[/code], clipped accordingly to both image bounds. Alpha channels are required for both [code]src[/code] and [code]mask[/code]. [code]dst[/code] pixels and [code]src[/code] pixels will blend if the corresponding mask pixel's alpha value is not 0. This image and [code]src[/code] image [b]must[/b] have the same format. [code]src[/code] image and [code]mask[/code] image [b]must[/b] have the same size (width and height) but they can have different formats. [code]src_rect[/code] with not positive size is treated as empty. - - - + + + Copies [code]src_rect[/code] from [code]src[/code] image to this image at coordinates [code]dst[/code], clipped accordingly to both image bounds. This image and [code]src[/code] image [b]must[/b] have the same format. [code]src_rect[/code] with not positive size is treated as empty. - - - - + + + + Blits [code]src_rect[/code] area from [code]src[/code] image to this image at the coordinates given by [code]dst[/code], clipped accordingly to both image bounds. [code]src[/code] pixel is copied onto [code]dst[/code] if the corresponding [code]mask[/code] pixel's alpha value is not 0. This image and [code]src[/code] image [b]must[/b] have the same format. [code]src[/code] image and [code]mask[/code] image [b]must[/b] have the same size (width and height) but they can have different formats. [code]src_rect[/code] with not positive size is treated as empty. - + Converts a bump map to a normal map. A bump map provides a height offset per-pixel, while a normal map provides a normal direction per pixel. @@ -73,25 +73,25 @@ - - - + + + Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See [enum CompressMode] and [enum CompressSource] constants. - - - + + + - - + + Compute image metrics on the current image and the compared image. The dictionary contains [code]max[/code], [code]mean[/code], [code]mean_squared[/code], [code]root_mean_squared[/code] and [code]peak_snr[/code]. @@ -99,43 +99,43 @@ - + Converts the image's format. See [enum Format] constants. - + Copies [code]src[/code] image to this image. - - - - + + + + Creates an empty image of given size and format. See [enum Format] constants. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [method generate_mipmaps]. - - - - - + + + + + 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 loads mipmaps for this image from [code]data[/code]. See [method generate_mipmaps]. - - + + Crops the image to the given [code]width[/code] and [code]height[/code]. If the specified size is larger than the current size, the extra area is filled with black pixels. @@ -155,21 +155,21 @@ - + - + Fills the image with [code]color[/code]. - - + + Fills [code]rect[/code] with [code]color[/code]. @@ -194,7 +194,7 @@ - + Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image's width/height is [code]0[/code]. [b]Note:[/b] Mipmap generation is done on the CPU, is single-threaded and is [i]always[/i] done on the main thread. This means generating mipmaps will result in noticeable stuttering during gameplay, even if [method generate_mipmaps] is called from a [Thread]. @@ -220,15 +220,15 @@ - + Returns the offset where the image's mipmap with index [code]mipmap[/code] is stored in the [code]data[/code] dictionary. - - + + 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 [Vector2i] argument. @@ -236,7 +236,7 @@ - + Returns the color of the pixel at [code]point[/code]. This is the same as [method get_pixel], but with a [Vector2i] argument instead of two integer arguments. @@ -244,7 +244,7 @@ - + Returns a new image that is a copy of the image's area specified with [code]rect[/code]. @@ -293,7 +293,7 @@ - + Loads an image from file [code]path[/code]. See [url=$DOCS_URL/tutorials/assets_pipeline/importing_images.html#supported-image-formats]Supported image formats[/url] for a list of supported image formats and limitations. [b]Warning:[/b] This method should only be used in the editor or in cases when you need to load external images at run-time, such as images located at the [code]user://[/code] directory, and may not work in exported projects. @@ -302,7 +302,7 @@ - + Loads an image from the binary contents of a BMP file. [b]Note:[/b] Godot's BMP module doesn't support 16-bit per pixel images. Only 1-bit, 4-bit, 8-bit, 24-bit, and 32-bit per pixel images are supported. @@ -310,35 +310,35 @@ - + Creates a new [Image] and loads data from the specified file. - + Loads an image from the binary contents of a JPEG file. - + Loads an image from the binary contents of a PNG file. - + Loads an image from the binary contents of a TGA file. - + Loads an image from the binary contents of a WebP file. @@ -357,17 +357,17 @@ - - - + + + Resizes the image to the given [code]width[/code] and [code]height[/code]. New pixels are calculated using the [code]interpolation[/code] mode defined via [enum Interpolation] constants. - - + + Resizes the image to the nearest power of 2 for the width and height. If [code]square[/code] is [code]true[/code] then set width and height to be the same. New pixels are calculated using the [code]interpolation[/code] mode defined via [enum Interpolation] constants. @@ -386,15 +386,15 @@ - + Rotates the image in the specified [code]direction[/code] by [code]90[/code] degrees. The width and height of the image must be greater than [code]1[/code]. If the width and height are not equal, the image will be resized. - - + + Saves the image as an EXR file to [code]path[/code]. If [code]grayscale[/code] is [code]true[/code] and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE] if Godot was compiled without the TinyEXR module. [b]Note:[/b] The TinyEXR module is disabled in non-editor builds, which means [method save_exr] will return [constant ERR_UNAVAILABLE] when it is called from an exported project. @@ -402,7 +402,7 @@ - + Saves the image as an EXR file to a byte array. If [code]grayscale[/code] is [code]true[/code] and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return an empty byte array if Godot was compiled without the TinyEXR module. [b]Note:[/b] The TinyEXR module is disabled in non-editor builds, which means [method save_exr] will return an empty byte array when it is called from an exported project. @@ -410,8 +410,8 @@ - - + + Saves the image as a JPEG file to [code]path[/code] with the specified [code]quality[/code] between [code]0.01[/code] and [code]1.0[/code] (inclusive). Higher [code]quality[/code] values result in better-looking output at the cost of larger file sizes. Recommended [code]quality[/code] values are between [code]0.75[/code] and [code]0.90[/code]. Even at quality [code]1.00[/code], JPEG compression remains lossy. [b]Note:[/b] JPEG does not save an alpha channel. If the [Image] contains an alpha channel, the image will still be saved, but the resulting JPEG file won't contain the alpha channel. @@ -419,7 +419,7 @@ - + Saves the image as a JPEG file to a byte array with the specified [code]quality[/code] between [code]0.01[/code] and [code]1.0[/code] (inclusive). Higher [code]quality[/code] values result in better-looking output at the cost of larger byte array sizes (and therefore memory usage). Recommended [code]quality[/code] values are between [code]0.75[/code] and [code]0.90[/code]. Even at quality [code]1.00[/code], JPEG compression remains lossy. [b]Note:[/b] JPEG does not save an alpha channel. If the [Image] contains an alpha channel, the image will still be saved, but the resulting byte array won't contain the alpha channel. @@ -427,7 +427,7 @@ - + Saves the image as a PNG file to the file at [code]path[/code]. @@ -440,26 +440,26 @@ - - - + + + Saves the image as a WebP (Web Picture) file to the file at [code]path[/code]. By default it will save lossless. If [code]lossy[/code] is true, the image will be saved lossy, using the [code]quality[/code] setting between 0.0 and 1.0 (inclusive). - - + + Saves the image as a WebP (Web Picture) file to a byte array. By default it will save lossless. If [code]lossy[/code] is true, the image will be saved lossy, using the [code]quality[/code] setting between 0.0 and 1.0 (inclusive). - - - + + + Sets the [Color] of the pixel at [code](x, y)[/code] to [code]color[/code]. Example: [codeblocks] @@ -485,8 +485,8 @@ - - + + Sets the [Color] of the pixel at [code]point[/code] to [code]color[/code]. Example: [codeblocks] diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index 084bf7e809..c750b540a4 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -31,7 +31,7 @@ - + Creates a new [ImageTexture] and initializes it by allocating and setting the data from an [Image]. @@ -44,7 +44,7 @@ - + Replaces the texture's data with a new [Image]. This will re-allocate new memory for the texture. If you want to update the image, but don't need to change its parameters (format, size), use [method update] instead for better performance. @@ -52,14 +52,14 @@ - + Resizes the texture to the specified dimensions. - + Replaces the texture's data with a new [Image]. [b]Note:[/b] The texture has to be created using [method create_from_image] or initialized first with the [method set_image] method before it can be updated. The new image dimensions, format, and mipmaps configuration should match the existing texture's image configuration. diff --git a/doc/classes/ImageTexture3D.xml b/doc/classes/ImageTexture3D.xml index b2068504eb..958c5f90f1 100644 --- a/doc/classes/ImageTexture3D.xml +++ b/doc/classes/ImageTexture3D.xml @@ -9,18 +9,18 @@ - - - - - - + + + + + + - + diff --git a/doc/classes/ImageTextureLayered.xml b/doc/classes/ImageTextureLayered.xml index c574e5c9c1..c0ad19ddd7 100644 --- a/doc/classes/ImageTextureLayered.xml +++ b/doc/classes/ImageTextureLayered.xml @@ -9,14 +9,14 @@ - + - - + + diff --git a/doc/classes/ImmediateMesh.xml b/doc/classes/ImmediateMesh.xml index d12d5de184..a6d2e3e249 100644 --- a/doc/classes/ImmediateMesh.xml +++ b/doc/classes/ImmediateMesh.xml @@ -17,22 +17,22 @@ - + Add a 3D vertex using the current attributes previously set. - + Add a 2D vertex using the current attributes previously set. - - + + Begin a new surface. @@ -45,35 +45,35 @@ - + Set the color attribute that will be pushed with the next vertex. - + Set the normal attribute that will be pushed with the next vertex. - + Set the tangent attribute that will be pushed with the next vertex. - + Set the UV attribute that will be pushed with the next vertex. - + Set the UV2 attribute that will be pushed with the next vertex. diff --git a/doc/classes/ImporterMesh.xml b/doc/classes/ImporterMesh.xml index 201c0ddd38..8afa35d1b4 100644 --- a/doc/classes/ImporterMesh.xml +++ b/doc/classes/ImporterMesh.xml @@ -13,20 +13,20 @@ - + Adds name for a blend shape that will be added with [method add_surface]. Must be called before surface is added. - - - - - - - + + + + + + + Creates a new surface, analogous to [method ArrayMesh.add_surface_from_arrays]. Surfaces are created to be rendered using a [code]primitive[/code], which may be any of the types defined in [enum Mesh.PrimitiveType]. (As a note, when using indices, it is recommended to only use points, lines, or triangles.) [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface. @@ -41,8 +41,8 @@ - - + + Generates all lods for this ImporterMesh. [code]normal_merge_angle[/code] and [code]normal_split_angle[/code] are in degrees and used in the same way as the importer settings in [code]lods[/code]. As a good default, use 25 and 60 respectively. @@ -63,7 +63,7 @@ - + Returns the name of the blend shape at this index. @@ -76,7 +76,7 @@ - + Returns the mesh data represented by this [ImporterMesh] as a usable [ArrayMesh]. This method caches the returned mesh, and subsequent calls will return the cached data until [method clear] is called. @@ -85,15 +85,15 @@ - + Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface. See [method add_surface]. - - + + Returns a single set of blend shape arrays for the requested blend shape index for a surface. @@ -106,81 +106,81 @@ - + Returns the format of the surface that the mesh holds. - + Returns the amount of lods that the mesh holds on a given surface. - - + + Returns the index buffer of a lod for a surface. - - + + Returns the screen ratio which activates a lod for a surface. - + Returns a [Material] in a given surface. Surface is rendered using this material. - + Gets the name assigned to this surface. - + Returns the primitive type of the requested surface (see [method add_surface]). - + Sets the blend shape mode to one of [enum Mesh.BlendShapeMode]. - + Sets the size hint of this mesh for lightmap-unwrapping in UV-space. - - + + Sets a [Material] for a given surface. Surface will be rendered using this material. - - + + Sets a name for a given surface. diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 796a80873f..d4e2923610 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -14,8 +14,8 @@ - - + + This will simulate pressing the specified action. The strength can be used for non-boolean actions, it's ranged between 0 and 1 representing the intensity of the given action. @@ -24,15 +24,15 @@ - + If the specified action is already pressed, this will release it. - - + + Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. @@ -54,8 +54,8 @@ - - + + Returns a value between 0 and 1 representing the raw intensity of the given action, ignoring the action's deadzone. In most cases, you should use [method get_action_strength] instead. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -63,8 +63,8 @@ - - + + Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis as the keyboard, the value returned will be 0 or 1. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -72,8 +72,8 @@ - - + + Get axis input by specifying two actions, one negative and one positive. This is a shorthand for writing [code]Input.get_action_strength("positive_action") - Input.get_action_strength("negative_action")[/code]. @@ -107,36 +107,36 @@ - - + + Returns the current value of the joypad axis at given index (see [enum JoyAxis]). - + Returns a SDL2-compatible device GUID on platforms that use gamepad remapping. Returns [code]"Default Gamepad"[/code] otherwise. - + Returns the name of the joypad at the specified device index. - + Returns the duration of the current vibration effect in seconds. - + Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor. @@ -162,11 +162,11 @@ - - - - - + + + + + Gets an input vector by specifying four actions for the positive and negative X and Y axes. This method is useful when getting vector input, such as from a joystick, directional pad, arrows, or WASD. The vector has its length limited to 1 and has a circular deadzone, which is useful for using vector input as movement. @@ -175,8 +175,8 @@ - - + + Returns [code]true[/code] when the user starts pressing the action event, meaning it's [code]true[/code] only on the frame that the user pressed down the button. This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed. @@ -186,8 +186,8 @@ - - + + Returns [code]true[/code] when the user stops pressing the action event, meaning it's [code]true[/code] only on the frame that the user released the button. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -195,8 +195,8 @@ - - + + Returns [code]true[/code] if you are pressing the action event. Note that if an action has multiple buttons assigned and more than one of them is pressed, releasing one button will release the action, even if some other button assigned to this action is still pressed. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -211,22 +211,22 @@ - - + + Returns [code]true[/code] if you are pressing the joypad button (see [enum JoyButton]). - + Returns [code]true[/code] if the system knows the specified device. This means that it sets all button and axis indices. Unknown joypads are not expected to match these constants, but you can still retrieve events from them. - + Returns [code]true[/code] if you are pressing the key in the current keyboard layout. You can pass a [enum Key] constant. [method is_key_pressed] is only recommended over [method is_physical_key_pressed] in non-game applications. This ensures that shortcut keys behave as expected depending on the user's keyboard layout, as keyboard shortcuts are generally dependent on the keyboard layout in non-game applications. If in doubt, use [method is_physical_key_pressed]. @@ -235,14 +235,14 @@ - + Returns [code]true[/code] if you are pressing the mouse button specified with [enum MouseButton]. - + Returns [code]true[/code] if you are pressing the key in the physical location on the 101/102-key US QWERTY keyboard. You can pass a [enum Key] constant. [method is_physical_key_pressed] is recommended over [method is_key_pressed] for in-game actions, as it will make [kbd]W[/kbd]/[kbd]A[/kbd]/[kbd]S[/kbd]/[kbd]D[/kbd] layouts work regardless of the user's keyboard layout. [method is_physical_key_pressed] will also ensure that the top row number keys work on any keyboard layout. If in doubt, use [method is_physical_key_pressed]. @@ -251,7 +251,7 @@ - + Feeds an [InputEvent] to the game. Can be used to artificially trigger input events from code. Also generates [method Node._input] calls. Example: @@ -273,14 +273,14 @@ - + Removes all mappings from the internal database that match the given GUID. - + Sets the acceleration value of the accelerometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS. @@ -288,9 +288,9 @@ - - - + + + Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. See [enum CursorShape] for the list of shapes. [code]image[/code]'s size must be lower than 256×256. @@ -301,7 +301,7 @@ - + Sets the default cursor shape to be used in the viewport instead of [constant CURSOR_ARROW]. [b]Note:[/b] If you want to change the default cursor shape for [Control]'s nodes, use [member Control.mouse_default_cursor_shape] instead. @@ -310,7 +310,7 @@ - + Sets the gravity value of the accelerometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS. @@ -318,7 +318,7 @@ - + Sets the value of the rotation rate of the gyroscope sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS. @@ -326,7 +326,7 @@ - + Sets the value of the magnetic field of the magnetometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS. @@ -334,10 +334,10 @@ - - - - + + + + Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. [code]weak_magnitude[/code] is the strength of the weak motor (between 0 and 1) and [code]strong_magnitude[/code] is the strength of the strong motor (between 0 and 1). [code]duration[/code] is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). [b]Note:[/b] Not every hardware is compatible with long effect durations; it is recommended to restart an effect if it has to be played for more than a few seconds. @@ -345,14 +345,14 @@ - + Stops the vibration of the joypad. - + Vibrate handheld devices. [b]Note:[/b] This method is implemented on Android, iOS, and HTML5. @@ -363,7 +363,7 @@ - + Sets the mouse position to the specified vector, provided in pixels and relative to an origin at the upper left corner of the currently focused Window Manager game window. Mouse position is clipped to the limits of the screen resolution, or to the limits of the game window if [enum MouseMode] is set to [code]MOUSE_MODE_CONFINED[/code] or [code]MOUSE_MODE_CONFINED_HIDDEN[/code]. @@ -382,8 +382,8 @@ - - + + Emitted when a joypad device has been connected or disconnected. diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 230ad04b33..71e94cf1a2 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -15,7 +15,7 @@ - + Returns [code]true[/code] if the given input event and this input event can be added together (only for events of type [InputEventMouseMotion]). The given input event's position, global position and speed will be copied. The resulting [code]relative[/code] is a sum of both events. Both events' modifiers have to be identical. @@ -29,8 +29,8 @@ - - + + Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type [InputEventJoypadMotion]. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -38,8 +38,8 @@ - - + + Returns [code]true[/code] if this input event matches a pre-defined action of any type. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -47,9 +47,9 @@ - - - + + + Returns [code]true[/code] if the given action is being pressed (and is not an echo event for [InputEventKey] events, unless [code]allow_echo[/code] is [code]true[/code]). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -58,8 +58,8 @@ - - + + Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -79,8 +79,8 @@ - - + + Returns [code]true[/code] if the specified [code]event[/code] matches this event. Only valid for action events i.e key ([InputEventKey]), button ([InputEventMouseButton] or [InputEventJoypadButton]), axis [InputEventJoypadMotion] or action ([InputEventAction]) events. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -95,8 +95,8 @@ - - + + Returns a copy of the given input event which has been offset by [code]local_ofs[/code] and transformed by [code]xform[/code]. Relevant for events of type [InputEventMouseButton], [InputEventMouseMotion], [InputEventScreenTouch], [InputEventScreenDrag], [InputEventMagnifyGesture] and [InputEventPanGesture]. diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index eb708432b4..8a58519a2b 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -12,37 +12,37 @@ - - + + Adds an [InputEvent] to an action. This [InputEvent] will trigger the action. - - + + Removes an [InputEvent] from an action. - + Removes all events from an action. - + Returns a deadzone value for the action. - + Returns an array of [InputEvent]s associated with a given action. [b]Note:[/b] When used in the editor (e.g. a tool script or [EditorPlugin]), this method will return events for the editor action. If you want to access your project's input binds from the editor, read the [code]input/*[/code] settings from [ProjectSettings]. @@ -50,24 +50,24 @@ - - + + Returns [code]true[/code] if the action has the given [InputEvent] associated with it. - - + + Sets a deadzone value for the action. - - + + Adds an empty action to the [InputMap] with a configurable [code]deadzone[/code]. An [InputEvent] can then be added to this action with [method action_add_event]. @@ -75,16 +75,16 @@ - + Removes an action from the [InputMap]. - - - + + + Returns [code]true[/code] if the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior. If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. @@ -98,7 +98,7 @@ - + Returns [code]true[/code] if the [InputMap] has a registered action with the given name. diff --git a/doc/classes/InstancePlaceholder.xml b/doc/classes/InstancePlaceholder.xml index d22028d478..f6d9c835d1 100644 --- a/doc/classes/InstancePlaceholder.xml +++ b/doc/classes/InstancePlaceholder.xml @@ -12,8 +12,8 @@ - - + + Not thread-safe. Use [method Object.call_deferred] if calling from a thread. @@ -26,7 +26,7 @@ - + diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index 97ee946acd..3375e5a758 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -15,17 +15,17 @@ - - + + Adds an item to the item list with no text, only an icon. Returns the index of an added item. - - - + + + Adds an item to the item list with specified text. Returns the index of an added item. Specify an [code]icon[/code], or use [code]null[/code] as the [code]icon[/code] for a list item with no icon. @@ -40,7 +40,7 @@ - + Ensures the item associated with the specified index is not selected. @@ -59,8 +59,8 @@ - - + + Returns the item index at the given [code]position[/code]. When there is no item at that point, -1 will be returned if [code]exact[/code] is [code]true[/code], and the closest item index will be returned otherwise. @@ -68,70 +68,70 @@ - + Returns the custom background color of the item specified by [code]idx[/code] index. - + Returns the custom foreground color of the item specified by [code]idx[/code] index. - + Returns the icon associated with the specified index. - + Returns a [Color] modulating item's icon at the specified index. - + Returns the region of item's icon used. The whole icon will be used if the region has no area. - + Returns item's text language code. - + Returns the metadata value of the specified index. - + Returns the text associated with the specified index. - + Returns item's text base writing direction. - + Returns the tooltip hint associated with the specified index. @@ -157,58 +157,58 @@ - + Returns [code]true[/code] if the item at the specified index is disabled. - + Returns [code]true[/code] if the item icon will be drawn transposed, i.e. the X and Y axes are swapped. - + Returns [code]true[/code] if the item at the specified index is selectable. - + Returns [code]true[/code] if the tooltip is enabled for specified item index. - + Returns [code]true[/code] if the item at the specified index is currently selected. - - + + Moves item from index [code]from_idx[/code] to [code]to_idx[/code]. - + Removes the item specified by [code]idx[/code] index from the list. - - + + Select the item at the specified index. [b]Note:[/b] This method does not trigger the item selection signal. @@ -216,24 +216,24 @@ - - + + Sets the background color of the item specified by [code]idx[/code] index to the specified [Color]. - - + + Sets the foreground color of the item specified by [code]idx[/code] index to the specified [Color]. - - + + Disables (or enables) the item at the specified index. Disabled items cannot be selected and do not trigger activation signals (when double-clicking or pressing [kbd]Enter[/kbd]). @@ -241,88 +241,88 @@ - - + + Sets (or replaces) the icon's [Texture2D] associated with the specified index. - - + + Sets a modulating [Color] of the item associated with the specified index. - - + + Sets the region of item's icon used. The whole icon will be used if the region has no area. - - + + Sets whether the item icon will be drawn transposed. - - + + Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. - - + + Sets a value (of any type) to be stored with the item associated with the specified index. - - + + Allows or disallows selection of the item associated with the specified index. - - + + Sets text of the item associated with the specified index. - - + + Sets item's text base writing direction. - - + + Sets the tooltip hint for the item associated with the specified index. - - + + Sets whether the tooltip hint is enabled for specified item index. @@ -385,37 +385,37 @@ - - + + Triggered when any mouse click is issued within the rect of the list but on empty space. - + Triggered when specified list item is activated via double-clicking or by pressing [kbd]Enter[/kbd]. - - - + + + Triggered when specified list item has been clicked with any mouse button. The click position is also provided to allow appropriate popup of context menus at the correct location. - + Triggered when specified item has been selected. [member allow_reselect] must be enabled to reselect an item. - - + + Triggered when a multiple selection is altered on a list allowing multiple selection. diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index 9650701c49..5d83c75417 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -50,7 +50,7 @@ - + Attempts to parse the [code]json_string[/code] provided. Returns an [enum Error]. If the parse was successful, it returns [code]OK[/code] and the result can be retrieved using [method get_data]. If unsuccessful, use [method get_error_line] and [method get_error_message] for identifying the source of the failure. @@ -58,10 +58,10 @@ - - - - + + + + Converts a [Variant] var to JSON text and returns the result. Useful for serializing data to store or send over the network. [b]Note:[/b] The JSON specification does not define integer or float types, but only a [i]number[/i] type. Therefore, converting a Variant to JSON text will convert all numerical values to [float] types. diff --git a/doc/classes/JSONRPC.xml b/doc/classes/JSONRPC.xml index cfe39d38a7..e8fb208fef 100644 --- a/doc/classes/JSONRPC.xml +++ b/doc/classes/JSONRPC.xml @@ -11,8 +11,8 @@ - - + + Returns a dictionary in the form of a JSON-RPC notification. Notifications are one-shot messages which do not expect a response. - [code]method[/code]: Name of the method being called. @@ -21,9 +21,9 @@ - - - + + + Returns a dictionary in the form of a JSON-RPC request. Requests are sent to a server with the expectation of a response. The ID field is used for the server to specify which exact request it is responding to. - [code]method[/code]: Name of the method being called. @@ -33,8 +33,8 @@ - - + + When a server has received and processed a request, it is expected to send a response. If you did not want a response then you need to have sent a Notification instead. - [code]result[/code]: The return value of the function which was called. @@ -43,9 +43,9 @@ - - - + + + Creates a response which indicates a previous reply has failed in some way. - [code]code[/code]: The error code corresponding to what kind of error this is. See the [enum ErrorCode] constants. @@ -55,8 +55,8 @@ - - + + Given a Dictionary which takes the form of a JSON-RPC request: unpack the request and run it. Methods are resolved by looking at the field called "method" and looking for an equivalently named function in the JSONRPC object. If one is found that method is called. To add new supported methods extend the JSONRPC class and call [method process_action] on your subclass. @@ -65,14 +65,14 @@ - + - - + + diff --git a/doc/classes/JavaClassWrapper.xml b/doc/classes/JavaClassWrapper.xml index fdfac2748b..d44a63938c 100644 --- a/doc/classes/JavaClassWrapper.xml +++ b/doc/classes/JavaClassWrapper.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/JavaScript.xml b/doc/classes/JavaScript.xml index 864028f3a6..d91e8bd3e5 100644 --- a/doc/classes/JavaScript.xml +++ b/doc/classes/JavaScript.xml @@ -13,23 +13,23 @@ - + Creates a reference to a [Callable] that can be used as a callback by JavaScript. The reference must be kept until the callback happens, or it won't be called at all. See [JavaScriptObject] for usage. - + Creates a new JavaScript object using the [code]new[/code] constructor. The [code]object[/code] must a valid property of the JavaScript [code]window[/code]. See [JavaScriptObject] for usage. - - - + + + Prompts the user to download a file containing the specified [code]buffer[/code]. The file will have the given [code]name[/code] and [code]mime[/code] type. [b]Note:[/b] The browser may override the [url=https://en.wikipedia.org/wiki/Media_type]MIME type[/url] provided based on the file [code]name[/code]'s extension. @@ -39,8 +39,8 @@ - - + + Execute the string [code]code[/code] as JavaScript code within the browser window. This is a call to the actual global JavaScript function [code]eval()[/code]. If [code]use_global_execution_context[/code] is [code]true[/code], the code will be evaluated in the global execution context. Otherwise, it is evaluated in the execution context of a function within the engine's runtime environment. @@ -48,7 +48,7 @@ - + Returns an interface to a JavaScript object that can be used by scripts. The [code]interface[/code] must be a valid property of the JavaScript [code]window[/code]. The callback must accept a single [Array] argument, which will contain the JavaScript [code]arguments[/code]. See [JavaScriptObject] for usage. diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index 1f3f0dbb6d..ca6aa05316 100644 --- a/doc/classes/KinematicCollision2D.xml +++ b/doc/classes/KinematicCollision2D.xml @@ -12,7 +12,7 @@ - + Returns the collision angle according to [code]up_direction[/code], which is [code]Vector2.UP[/code] by default. This value is always positive. diff --git a/doc/classes/KinematicCollision3D.xml b/doc/classes/KinematicCollision3D.xml index 6327d48d38..08ceebdf91 100644 --- a/doc/classes/KinematicCollision3D.xml +++ b/doc/classes/KinematicCollision3D.xml @@ -12,50 +12,50 @@ - - + + Returns the collision angle according to [code]up_direction[/code], which is [code]Vector3.UP[/code] by default. This value is always positive. - + Returns the colliding body's attached [Object] given a collision index (the deepest collision by default). - + Returns the unique instance ID of the colliding body's attached [Object] given a collision index (the deepest collision by default). See [method Object.get_instance_id]. - + Returns the colliding body's [RID] used by the [PhysicsServer3D] given a collision index (the deepest collision by default). - + Returns the colliding body's shape given a collision index (the deepest collision by default). - + Returns the colliding body's shape index given a collision index (the deepest collision by default). See [CollisionObject3D]. - + Returns the colliding body's velocity given a collision index (the deepest collision by default). @@ -68,21 +68,21 @@ - + Returns the moving object's colliding shape given a collision index (the deepest collision by default). - + Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default). - + Returns the point of collision in global coordinates given a collision index (the deepest collision by default). diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index 1ebf770f7e..d882405384 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -19,7 +19,7 @@ - + Returns the height of the line [code]line[/code]. If [code]line[/code] is set to [code]-1[/code], returns the biggest line height. diff --git a/doc/classes/Label3D.xml b/doc/classes/Label3D.xml index 5ba0a2d79a..56690d484d 100644 --- a/doc/classes/Label3D.xml +++ b/doc/classes/Label3D.xml @@ -17,15 +17,15 @@ - + Returns the value of the specified flag. - - + + If [code]true[/code], the specified flag will be enabled. See [enum Label3D.DrawFlags] for a list of flags. diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index 32bf6a67a9..00815758a1 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -18,7 +18,7 @@ - + diff --git a/doc/classes/Light3D.xml b/doc/classes/Light3D.xml index 46c3e57547..80ff83ec46 100644 --- a/doc/classes/Light3D.xml +++ b/doc/classes/Light3D.xml @@ -13,15 +13,15 @@ - + Returns the value of the specified [enum Light3D.Param] parameter. - - + + Sets the value of the specified [enum Light3D.Param] parameter. diff --git a/doc/classes/LightmapGIData.xml b/doc/classes/LightmapGIData.xml index 13f44150d7..0881d3de8a 100644 --- a/doc/classes/LightmapGIData.xml +++ b/doc/classes/LightmapGIData.xml @@ -11,10 +11,10 @@ - - - - + + + + Adds an object that is considered baked within this [LightmapGIData]. @@ -33,7 +33,7 @@ - + Returns the [NodePath] of the baked object at index [code]user_idx[/code]. @@ -46,7 +46,7 @@ - + If [code]uses_spherical_harmonics[/code] is [code]true[/code], tells the engine to treat the lightmap data as if it was baked with directional information. [b]Note:[/b] Changing this value on already baked lightmaps will not cause them to be baked again. This means the material appearance will look incorrect until lightmaps are baked again, in which case the value set here is discarded as the entire [LightmapGIData] resource is replaced by the lightmapper. diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index e2cc43bb75..0bca77749d 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -13,8 +13,8 @@ - - + + Adds a point at the [code]position[/code]. Appends the point at the end of the line. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position < 0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. @@ -34,22 +34,22 @@ - + Returns point [code]i[/code]'s position. - + Removes the point at index [code]i[/code] from the line. - - + + Overwrites the position in point [code]i[/code] with the supplied [code]position[/code]. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 2ff13a676b..c06118e621 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -45,8 +45,8 @@ - - + + Deletes a section of the [member text] going from position [code]from_column[/code] to [code]to_column[/code]. Both parameters should be within the text's length. @@ -90,7 +90,7 @@ - + Inserts [code]text[/code] at the caret. If the resulting value is longer than [member max_length], nothing happens. @@ -103,15 +103,15 @@ - + Executes a given action as defined in the [enum MenuItems] enum. - - + + Selects characters inside [LineEdit] between [code]from[/code] and [code]to[/code]. By default, [code]from[/code] is at the beginning and [code]to[/code] at the end. [codeblocks] @@ -252,19 +252,19 @@ - + Emitted when appending text that overflows the [member max_length]. The appended text is truncated to fit [member max_length], and the part that couldn't fit is passed as the [code]rejected_substring[/code] argument. - + Emitted when the text changes. - + Emitted when the user presses [constant KEY_ENTER] on the [LineEdit]. diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml index 2cf41b750a..acc59a307b 100644 --- a/doc/classes/MainLoop.xml +++ b/doc/classes/MainLoop.xml @@ -74,7 +74,7 @@ - + Called each physics frame with the time since the last physics frame as argument ([code]delta[/code], in seconds). Equivalent to [method Node._physics_process]. If implemented, the method must return a boolean value. [code]true[/code] ends the main loop, while [code]false[/code] lets it proceed to the next frame. @@ -82,7 +82,7 @@ - + Called each process (idle) frame with the time since the last process frame as argument (in seconds). Equivalent to [method Node._process]. If implemented, the method must return a boolean value. [code]true[/code] ends the main loop, while [code]false[/code] lets it proceed to the next frame. @@ -91,8 +91,8 @@ - - + + Emitted when a user responds to a permission request. diff --git a/doc/classes/Marshalls.xml b/doc/classes/Marshalls.xml index b66a1b9190..ac7b4a48b9 100644 --- a/doc/classes/Marshalls.xml +++ b/doc/classes/Marshalls.xml @@ -11,22 +11,22 @@ - + Returns a decoded [PackedByteArray] corresponding to the Base64-encoded string [code]base64_str[/code]. - + Returns a decoded string corresponding to the Base64-encoded string [code]base64_str[/code]. - - + + Returns a decoded [Variant] corresponding to the Base64-encoded string [code]base64_str[/code]. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. @@ -34,22 +34,22 @@ - + Returns a Base64-encoded string of a given [PackedByteArray]. - + Returns a Base64-encoded string of the UTF-8 string [code]utf8_str[/code]. - - + + Returns a Base64-encoded string of the [Variant] [code]variant[/code]. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code). diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index bec567b3ef..8baa724292 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -20,7 +20,7 @@ - + If [code]true[/code], shortcuts are disabled and cannot be used to trigger the button. diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index 48fa2754d5..f708917b4b 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -25,7 +25,7 @@ - + @@ -36,70 +36,70 @@ - - + + - + - + - + - + - + - + - + - + - - + + - - + + Calculate a [ConvexPolygonShape3D] from the mesh. If [code]clean[/code] is [code]true[/code] (default), duplicate and interior vertices are removed automatically. You can set it to [code]false[/code] to make the process faster if not needed. @@ -108,7 +108,7 @@ - + Calculate an outline mesh at a defined offset (margin) from the original mesh. [b]Note:[/b] This method typically returns the vertices in reverse order (e.g. clockwise to counterclockwise). @@ -147,29 +147,29 @@ - + Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface (see [method ArrayMesh.add_surface_from_arrays]). - + Returns the blend shape arrays for the requested surface. - + Returns a [Material] in a given surface. Surface is rendered using this material. - - + + Sets a [Material] for a given surface. Surface will be rendered using this material. diff --git a/doc/classes/MeshDataTool.xml b/doc/classes/MeshDataTool.xml index 0042bb20d8..b46f080a10 100644 --- a/doc/classes/MeshDataTool.xml +++ b/doc/classes/MeshDataTool.xml @@ -59,15 +59,15 @@ - + Adds a new surface to specified [Mesh] with edited data. - - + + Uses specified surface of given [Mesh] to populate data for MeshDataTool. Requires [Mesh] with primitive type [constant Mesh.PRIMITIVE_TRIANGLES]. @@ -81,22 +81,22 @@ - + Returns array of faces that touch given edge. - + Returns meta information assigned to given edge. - - + + Returns index of specified vertex connected to given edge. Vertex argument can only be 0 or 1 because edges are comprised of two vertices. @@ -110,8 +110,8 @@ - - + + Returns specified edge associated with given face. Edge argument must be either 0, 1, or 2 because a face only has three edges. @@ -119,22 +119,22 @@ - + Returns the metadata associated with the given face. - + Calculates and returns the face normal of the given face. - - + + Returns the specified vertex of the given face. Vertex argument must be either 0, 1, or 2 because faces contain three vertices. @@ -155,21 +155,21 @@ - + Returns the vertex at given index. - + Returns the bones of the given vertex. - + Returns the color of the given vertex. @@ -182,151 +182,151 @@ - + Returns an array of edges that share the given vertex. - + Returns an array of faces that share the given vertex. - + Returns the metadata associated with the given vertex. - + Returns the normal of the given vertex. - + Returns the tangent of the given vertex. - + Returns the UV of the given vertex. - + Returns the UV2 of the given vertex. - + Returns bone weights of the given vertex. - - + + Sets the metadata of the given edge. - - + + Sets the metadata of the given face. - + Sets the material to be used by newly-constructed [Mesh]. - - + + Sets the position of the given vertex. - - + + Sets the bones of the given vertex. - - + + Sets the color of the given vertex. - - + + Sets the metadata associated with the given vertex. - - + + Sets the normal of the given vertex. - - + + Sets the tangent of the given vertex. - - + + Sets the UV of the given vertex. - - + + Sets the UV2 of the given vertex. - - + + Sets the bone weights of the given vertex. diff --git a/doc/classes/MeshInstance3D.xml b/doc/classes/MeshInstance3D.xml index 24f1f9918b..1e69af6fd7 100644 --- a/doc/classes/MeshInstance3D.xml +++ b/doc/classes/MeshInstance3D.xml @@ -15,8 +15,8 @@ - - + + This helper creates a [StaticBody3D] child node with a [ConvexPolygonShape3D] collision shape calculated from the mesh geometry. It's mainly used for testing. If [code]clean[/code] is [code]true[/code] (default), duplicate and interior vertices are removed automatically. You can set it to [code]false[/code] to make the process faster if not needed. @@ -43,13 +43,13 @@ - + - + Returns the [Material] that will be used by the [Mesh] when drawing. This can return the [member GeometryInstance3D.material_override], the surface override [Material] defined in this [MeshInstance3D], or the surface [Material] defined in the [Mesh]. For example, if [member GeometryInstance3D.material_override] is used, all surfaces will return the override material. @@ -61,13 +61,13 @@ - + - + Returns the override [Material] for the specified surface of the [Mesh] resource. @@ -80,15 +80,15 @@ - - + + - - + + Sets the override [Material] for the specified surface of the [Mesh] resource. This material is associated with this [MeshInstance3D] rather than with the [Mesh] resource. diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml index 6b25441a16..85e57dd0f3 100644 --- a/doc/classes/MeshLibrary.xml +++ b/doc/classes/MeshLibrary.xml @@ -19,7 +19,7 @@ - + Creates a new item in the library with the given ID. You can get an unused ID from [method get_last_unused_item_id]. @@ -27,7 +27,7 @@ - + Returns the first item with the given name. @@ -40,49 +40,49 @@ - + Returns the item's mesh. - + Returns the transform applied to the item's mesh. - + Returns the item's name. - + Returns the item's navigation mesh. - + Returns the transform applied to the item's navigation mesh. - + When running in the editor, returns a generated item preview (a 3D rendering in isometric perspective). When used in a running project, returns the manually-defined item preview which can be set using [method set_item_preview]. Returns an empty [Texture2D] if no preview was manually set in a running project. - + Returns an item's collision shapes. The array consists of each [Shape3D] followed by its [Transform3D]. @@ -96,31 +96,31 @@ - + Removes the item. - - + + Sets the item's mesh. - - + + Sets the transform to apply to the item's mesh. - - + + Sets the item's name. This name is shown in the editor. It can also be used to look up the item later using [method find_item_by_name]. @@ -128,32 +128,32 @@ - - + + Sets the item's navigation mesh. - - + + Sets the transform to apply to the item's navigation mesh. - - + + Sets a texture to use as the item's preview icon in the editor. - - + + Sets an item's collision shapes. The array should consist of [Shape3D] objects, each followed by a [Transform3D] that will be applied to it. For shapes that should not have a transform, use [constant Transform3D.IDENTITY]. diff --git a/doc/classes/MethodTweener.xml b/doc/classes/MethodTweener.xml index b22341e0a1..7e042b5eb6 100644 --- a/doc/classes/MethodTweener.xml +++ b/doc/classes/MethodTweener.xml @@ -12,21 +12,21 @@ - + Sets the time in seconds after which the [MethodTweener] will start interpolating. By default there's no delay. - + Sets the type of used easing from [enum Tween.EaseType]. If not set, the default easing is used from the [Tween] that contains this Tweener. - + Sets the type of used transition from [enum Tween.TransitionType]. If not set, the default transition is used from the [Tween] that contains this Tweener. diff --git a/doc/classes/MovieWriter.xml b/doc/classes/MovieWriter.xml index d47e52d7c0..9701f49b99 100644 --- a/doc/classes/MovieWriter.xml +++ b/doc/classes/MovieWriter.xml @@ -29,7 +29,7 @@ - + Called when the engine determines whether this [MovieWriter] is able to handle the file at [code]path[/code]. Must return [code]true[/code] if this [MovieWriter] is able to handle the given file path, [code]false[/code] otherwise. Typically, [method _handles_file] is overridden as follows to allow the user to record a file at any path with a given file extension: [codeblock] @@ -42,9 +42,9 @@ - - - + + + Called once before the engine starts writing video and audio data. [code]movie_size[/code] is the width and height of the video to save. [code]fps[/code] is the number of frames per second specified in the project settings or using the [code]--fixed-fps <fps>[/code] command line argument. @@ -58,15 +58,15 @@ - - + + Called at the end of every rendered frame. The [code]frame_image[/code] and [code]audio_frame_block[/code] function arguments should be written to. - + Adds a writer to be usable by the engine. The supported file extensions can be set by overriding [method _handles_file]. [b]Note:[/b] [method add_writer] must be called early enough in the engine initialization to work, as movie writing is designed to start at the same time as the rest of the engine. diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index 3431a3347b..bae2335cfb 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -22,36 +22,36 @@ - + Gets a specific instance's color. - + Returns the custom data that has been set for a specific instance. - + Returns the [Transform3D] of a specific instance. - + Returns the [Transform2D] of a specific instance. - - + + Sets the color of a specific instance by [i]multiplying[/i] the mesh's existing vertex colors. For the color to take effect, ensure that [member use_colors] is [code]true[/code] on the [MultiMesh] and [member BaseMaterial3D.vertex_color_use_as_albedo] is [code]true[/code] on the material. If the color doesn't look as expected, make sure the material's albedo color is set to pure white ([code]Color(1, 1, 1)[/code]). @@ -59,8 +59,8 @@ - - + + Sets custom data for a specific instance. Although [Color] is used, it is just a container for 4 floating point numbers. For the custom data to be used, ensure that [member use_custom_data] is [code]true[/code]. @@ -68,16 +68,16 @@ - - + + Sets the [Transform3D] for a specific instance. - - + + Sets the [Transform2D] for a specific instance. diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index 06658bf004..e0a3a29147 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -57,8 +57,8 @@ - - + + Notifies the MultiplayerAPI of a new [code]configuration[/code] for the given [code]object[/code]. This method is used internally by [SceneTree] to configure the root path for this MultiplayerAPI (passing [code]null[/code] and a valid [NodePath] as [code]configuration[/code]). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g. [SceneMultiplayer]) for details on how they use it. [b]Note:[/b] This method is mostly relevant when extending or overriding the MultiplayerAPI behavior via [MultiplayerAPIExtension]. @@ -66,8 +66,8 @@ - - + + Notifies the MultiplayerAPI to remove a [code]configuration[/code] for the given [code]object[/code]. This method is used internally by [SceneTree] to configure the root path for this MultiplayerAPI (passing [code]null[/code] and an empty [NodePath] as [code]configuration[/code]). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g. [SceneMultiplayer]) for details on how they use it. [b]Note:[/b] This method is mostly relevant when extending or overriding the MultiplayerAPI behavior via [MultiplayerAPIExtension]. @@ -82,10 +82,10 @@ - - - - + + + + Sends an RPC to the target [code]peer[/code]. The given [code]method[/code] will be called on the remote [code]object[/code] with the provided [code]arguments[/code]. The RPC may also be called locally depending on the implementation and RPC configuration. See [method Node.rpc] and [method Node.rpc_config]. [b]Note:[/b] Prefer using [method Node.rpc], [method Node.rpc_id], or [code]my_method.rpc(peer, arg1, arg2, ...)[/code] (in GDScript), since they are faster. This method is mostly useful in conjunction with [MultiplayerAPIExtension] when augmenting or replacing the multiplayer capabilities. @@ -93,7 +93,7 @@ - + Sets the default MultiplayerAPI implementation class. This method can be used by modules and extensions to configure which implementation will be used by [SceneTree] when the engine starts. @@ -116,13 +116,13 @@ - + Emitted when this MultiplayerAPI's [member multiplayer_peer] connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). - + Emitted when this MultiplayerAPI's [member multiplayer_peer] disconnects from a peer. Clients get notified when other clients disconnect from the same server. diff --git a/doc/classes/MultiplayerAPIExtension.xml b/doc/classes/MultiplayerAPIExtension.xml index c369977d57..e67970cc89 100644 --- a/doc/classes/MultiplayerAPIExtension.xml +++ b/doc/classes/MultiplayerAPIExtension.xml @@ -100,16 +100,16 @@ - - + + Callback for [method MultiplayerAPI.object_configuration_add]. - - + + Callback for [method MultiplayerAPI.object_configuration_remove]. @@ -122,17 +122,17 @@ - - - - + + + + Callback for [method MultiplayerAPI.rpc]. - + Called when the [member MultiplayerAPI.multiplayer_peer] is set. diff --git a/doc/classes/MultiplayerPeer.xml b/doc/classes/MultiplayerPeer.xml index 6dde40f018..9e747383b6 100644 --- a/doc/classes/MultiplayerPeer.xml +++ b/doc/classes/MultiplayerPeer.xml @@ -45,7 +45,7 @@ - + Sets the peer to which packets will be sent. The [code]id[/code] can be one of: [constant TARGET_PEER_BROADCAST] to send to all connected peers, [constant TARGET_PEER_SERVER] to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. By default, the target peer is [constant TARGET_PEER_BROADCAST]. @@ -76,13 +76,13 @@ - + Emitted by the server when a client connects. - + Emitted by the server when a client disconnects. diff --git a/doc/classes/MultiplayerPeerExtension.xml b/doc/classes/MultiplayerPeerExtension.xml index f837171e2f..12e281fa76 100644 --- a/doc/classes/MultiplayerPeerExtension.xml +++ b/doc/classes/MultiplayerPeerExtension.xml @@ -29,8 +29,8 @@ - - + + Called when a packet needs to be received by the [MultiplayerAPI], with [code]p_buffer_size[/code] being the size of the binary [code]p_buffer[/code] in bytes. @@ -85,43 +85,43 @@ - - + + Called when a packet needs to be sent by the [MultiplayerAPI], with [code]p_buffer_size[/code] being the size of the binary [code]p_buffer[/code] in bytes. - + Called when a packet needs to be sent by the [MultiplayerAPI], if [method _put_packet] isn't implemented. Use this when extending this class via GDScript. - + Called when the "refuse new connections" status is set on this [MultiplayerPeer] (see [member MultiplayerPeer.refuse_new_connections]). - + Called when the target peer to use is set for this [MultiplayerPeer] (see [method MultiplayerPeer.set_target_peer]). - + Called when the channel to use is set for this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_channel]). - + Called when the transfer mode is set on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_mode]). diff --git a/doc/classes/NativeExtension.xml b/doc/classes/NativeExtension.xml index e5e11c1c95..50f976ca6f 100644 --- a/doc/classes/NativeExtension.xml +++ b/doc/classes/NativeExtension.xml @@ -19,7 +19,7 @@ - + @@ -30,8 +30,8 @@ - - + + diff --git a/doc/classes/NativeExtensionManager.xml b/doc/classes/NativeExtensionManager.xml index 10c9e32cf2..7d6eefa94f 100644 --- a/doc/classes/NativeExtensionManager.xml +++ b/doc/classes/NativeExtensionManager.xml @@ -9,7 +9,7 @@ - + @@ -20,25 +20,25 @@ - + - + - + - + diff --git a/doc/classes/NavigationAgent2D.xml b/doc/classes/NavigationAgent2D.xml index 058f1032cb..c2b57404dc 100644 --- a/doc/classes/NavigationAgent2D.xml +++ b/doc/classes/NavigationAgent2D.xml @@ -36,7 +36,7 @@ - + Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32. @@ -85,29 +85,29 @@ - - + + Based on [code]value[/code], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [code]layer_number[/code] between 1 and 32. - + Sets the [RID] of the navigation map this NavigationAgent node should use and also updates the [code]agent[/code] on the NavigationServer. - + Sets the user desired final location. This will clear the current navigation path. - + Sends the passed in velocity to the collision avoidance algorithm. It will adjust the velocity to avoid collisions. Once the adjustment to the velocity is complete, it will emit the [signal velocity_computed] signal. @@ -163,7 +163,7 @@ - + Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity]. diff --git a/doc/classes/NavigationAgent3D.xml b/doc/classes/NavigationAgent3D.xml index c689ddc345..d4221240ba 100644 --- a/doc/classes/NavigationAgent3D.xml +++ b/doc/classes/NavigationAgent3D.xml @@ -36,7 +36,7 @@ - + Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32. @@ -85,29 +85,29 @@ - - + + Based on [code]value[/code], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [code]layer_number[/code] between 1 and 32. - + Sets the [RID] of the navigation map this NavigationAgent node should use and also updates the [code]agent[/code] on the NavigationServer. - + Sets the user desired final location. This will clear the current navigation path. - + Sends the passed in velocity to the collision avoidance algorithm. It will adjust the velocity to avoid collisions. Once the adjustment to the velocity is complete, it will emit the [signal velocity_computed] signal. @@ -169,7 +169,7 @@ - + Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity]. diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index 33d2535ca2..cef23699c8 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -12,7 +12,7 @@ - + Adds a polygon using the indices of the vertices you get when calling [method get_vertices]. @@ -25,7 +25,7 @@ - + Initializes the navigation mesh by setting the vertices and indices according to a [Mesh]. [b]Note:[/b] The given [code]mesh[/code] must be of type [constant Mesh.PRIMITIVE_TRIANGLES] and have an index array. @@ -33,14 +33,14 @@ - + Returns whether or not the specified layer of the [member geometry_collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. - + Returns a [PackedInt32Array] containing the indices of the vertices of a created polygon. @@ -59,15 +59,15 @@ - - + + Based on [code]value[/code], enables or disables the specified layer in the [member geometry_collision_mask], given a [code]layer_number[/code] between 1 and 32. - + Sets the vertices that can be then indexed to create polygons with the [method add_polygon] method. diff --git a/doc/classes/NavigationMeshGenerator.xml b/doc/classes/NavigationMeshGenerator.xml index 612ce54d34..30d068b55c 100644 --- a/doc/classes/NavigationMeshGenerator.xml +++ b/doc/classes/NavigationMeshGenerator.xml @@ -15,15 +15,15 @@ - - + + Bakes navigation data to the provided [code]nav_mesh[/code] by parsing child nodes under the provided [code]root_node[/code] or a specific group of nodes for potential source geometry. The parse behavior can be controlled with the [member NavigationMesh.geometry_parsed_geometry_type] and [member NavigationMesh.geometry_source_geometry_mode] properties on the [NavigationMesh] resource. - + Removes all polygons and vertices from the provided [code]nav_mesh[/code] resource. diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 0a2ceeedc5..19466c171f 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -48,22 +48,22 @@ - + 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 [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]. @@ -88,7 +88,7 @@ - + Returns a [PackedVector2Array] containing the vertices of an outline that was created in the editor or by script. @@ -101,7 +101,7 @@ - + Returns a [PackedInt32Array] containing the indices of the vertices of a created polygon. @@ -126,22 +126,22 @@ - + Removes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update. - - + + Changes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update. - + Sets the vertices that can be then indexed to create polygons with the [method add_polygon] method. diff --git a/doc/classes/NavigationRegion2D.xml b/doc/classes/NavigationRegion2D.xml index 75b6544827..655d51b25c 100644 --- a/doc/classes/NavigationRegion2D.xml +++ b/doc/classes/NavigationRegion2D.xml @@ -16,7 +16,7 @@ - + Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32. @@ -29,8 +29,8 @@ - - + + Based on [code]value[/code], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [code]layer_number[/code] between 1 and 32. diff --git a/doc/classes/NavigationRegion3D.xml b/doc/classes/NavigationRegion3D.xml index f5824a24fd..927b2ba5e5 100644 --- a/doc/classes/NavigationRegion3D.xml +++ b/doc/classes/NavigationRegion3D.xml @@ -16,14 +16,14 @@ - + Bakes the [NavigationMesh]. If [code]on_thread[/code] is set to [code]true[/code] (default), the baking is done on a separate thread. Baking on separate thread is useful because navigation baking is not a cheap operation. When it is completed, it automatically sets the new [NavigationMesh]. Please note that baking on separate thread may be very slow if geometry is parsed from meshes as async access to each mesh involves heavy synchronization. Also, please note that baking on a separate thread is automatically disabled on operating systems that cannot use threads (such as HTML5 with threads disabled). - + Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32. @@ -36,8 +36,8 @@ - - + + Based on [code]value[/code], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [code]layer_number[/code] between 1 and 32. diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml index 36379d2531..8469099b80 100644 --- a/doc/classes/NavigationServer2D.xml +++ b/doc/classes/NavigationServer2D.xml @@ -25,24 +25,24 @@ - + Returns the navigation map [RID] the requested [code]agent[/code] is currently assigned to. - + Returns true if the map got changed the previous frame. - - - - + + + + Callback called at the end of the RVO process. If a callback is created manually and the agent is placed on a navigation map it will calculate avoidance for the agent and dispatch the calculated [code]safe_velocity[/code] to the [code]receiver[/code] object with a signal to the chosen [code]method[/code] name. [b]Note:[/b] Created callbacks are always processed independently of the SceneTree state as long as the agent is on a navigation map and not freed. To disable the dispatch of a callback from an agent use [method agent_set_callback] again with a [code]null[/code] object as the [code]receiver[/code]. @@ -50,79 +50,79 @@ - - + + Puts the agent in the map. - - + + Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. - - + + Sets the maximum speed of the agent. Must be positive. - - + + Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. - - + + Sets the position of the agent in world space. - - + + Sets the radius of the agent. - - + + Sets the new target velocity. - - + + The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. Must be positive. - - + + Sets the current velocity of the agent. - + Destroys the given RID. @@ -141,7 +141,7 @@ - + This function immediately forces synchronization of the specified navigation [code]map[/code] [RID]. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed). Due to technical restrictions the current NavigationServer command queue will be flushed. This means all already queued update commands for this physics frame will be executed, even those intended for other maps, regions and agents not part of the specified map. The expensive computation of the navigation meshes and region connections of a map will only be done for the specified map. Other maps will receive the normal synchronization at the end of the physics frame. Should the specified map receive changes after the forced update it will update again as well when the other maps receive their update. @@ -151,86 +151,86 @@ - + Returns all navigation agents [RID]s that are currently assigned to the requested navigation [code]map[/code]. - + Returns the map cell size. - - + + Returns the point closest to the provided [code]to_point[/code] on the navigation mesh surface. - - + + Returns the owner region RID for the point returned by [method map_get_closest_point]. - + Returns the edge connection margin of the map. The edge connection margin is a distance used to connect two regions. - - - - - + + + + + Returns the navigation path to reach the destination from the origin. [code]navigation_layers[/code] is a bitmask of all region navigation layers that are allowed to be in the path. - + Returns all navigation regions [RID]s that are currently assigned to the requested navigation [code]map[/code]. - + Returns true if the map is active. - - + + Sets the map active. - - + + Set the map cell size used to weld the navigation mesh polygons. - - + + Set the map edge connection margin used to weld the compatible region edges. @@ -243,59 +243,59 @@ - - + + Returns the ending point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. - - + + Returns the starting point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. - + Returns how many connections this [code]region[/code] has with other regions in the map. - + Returns the [code]enter_cost[/code] of this [code]region[/code]. - + Returns the navigation map [RID] the requested [code]region[/code] is currently assigned to. - + Returns the region's navigation layers. - + Returns the [code]travel_cost[/code] of this [code]region[/code]. - - + + Returns [code]true[/code] if the provided [code]point[/code] in world space is currently owned by the provided navigation [code]region[/code]. Owned in this context means that one of the region's navigation mesh polygon faces has a possible position at the closest distance to this point compared to all other navigation meshes from other navigation regions that are also registered on the navigation map of the provided region. If multiple navigation meshes have positions at equal distance the navigation region whose polygons are processed first wins the ownership. Polygons are processed in the same order that navigation regions were registered on the NavigationServer. @@ -304,48 +304,48 @@ - - + + Sets the [code]enter_cost[/code] for this [code]region[/code]. - - + + Sets the map for the region. - - + + Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer2D.map_get_path]). - - + + Sets the navigation mesh for the region. - - + + Sets the global transformation for the region. - - + + Sets the [code]travel_cost[/code] for this [code]region[/code]. @@ -353,7 +353,7 @@ - + Emitted when a navigation map is updated, when a region moves or is modified. diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index 8600c2643a..f9dfd01c41 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -25,24 +25,24 @@ - + Returns the navigation map [RID] the requested [code]agent[/code] is currently assigned to. - + Returns true if the map got changed the previous frame. - - - - + + + + Callback called at the end of the RVO process. If a callback is created manually and the agent is placed on a navigation map it will calculate avoidance for the agent and dispatch the calculated [code]safe_velocity[/code] to the [code]receiver[/code] object with a signal to the chosen [code]method[/code] name. [b]Note:[/b] Created callbacks are always processed independently of the SceneTree state as long as the agent is on a navigation map and not freed. To disable the dispatch of a callback from an agent use [method agent_set_callback] again with a [code]null[/code] object as the [code]receiver[/code]. @@ -50,79 +50,79 @@ - - + + Puts the agent in the map. - - + + Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. - - + + Sets the maximum speed of the agent. Must be positive. - - + + Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. - - + + Sets the position of the agent in world space. - - + + Sets the radius of the agent. - - + + Sets the new target velocity. - - + + The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. Must be positive. - - + + Sets the current velocity of the agent. - + Destroys the given RID. @@ -141,7 +141,7 @@ - + This function immediately forces synchronization of the specified navigation [code]map[/code] [RID]. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed). Due to technical restrictions the current NavigationServer command queue will be flushed. This means all already queued update commands for this physics frame will be executed, even those intended for other maps, regions and agents not part of the specified map. The expensive computation of the navigation meshes and region connections of a map will only be done for the specified map. Other maps will receive the normal synchronization at the end of the physics frame. Should the specified map receive changes after the forced update it will update again as well when the other maps receive their update. @@ -151,126 +151,126 @@ - + Returns all navigation agents [RID]s that are currently assigned to the requested navigation [code]map[/code]. - + Returns the map cell size. - - + + Returns the point closest to the provided [code]point[/code] on the navigation mesh surface. - - + + Returns the normal for the point returned by [method map_get_closest_point]. - - + + Returns the owner region RID for the point returned by [method map_get_closest_point]. - - - - + + + + Returns the closest point between the navigation surface and the segment. - + Returns the edge connection margin of the map. This distance is the minimum vertex distance needed to connect two edges from different regions. - - - - - + + + + + Returns the navigation path to reach the destination from the origin. [code]navigation_layers[/code] is a bitmask of all region navigation layers that are allowed to be in the path. - + Returns all navigation regions [RID]s that are currently assigned to the requested navigation [code]map[/code]. - + Returns the map's up direction. - + Returns true if the map is active. - - + + Sets the map active. - - + + Set the map cell size used to weld the navigation mesh polygons. - - + + Set the map edge connection margin used to weld the compatible region edges. - - + + Sets the map up direction. - + Process the collision avoidance agents. The result of this process is needed by the physics server, so this must be called in the main thread. @@ -279,8 +279,8 @@ - - + + Bakes the navigation mesh. @@ -293,59 +293,59 @@ - - + + Returns the ending point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. - - + + Returns the starting point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. - + Returns how many connections this [code]region[/code] has with other regions in the map. - + Returns the [code]enter_cost[/code] of this [code]region[/code]. - + Returns the navigation map [RID] the requested [code]region[/code] is currently assigned to. - + Returns the region's navigation layers. - + Returns the [code]travel_cost[/code] of this [code]region[/code]. - - + + Returns [code]true[/code] if the provided [code]point[/code] in world space is currently owned by the provided navigation [code]region[/code]. Owned in this context means that one of the region's navigation mesh polygon faces has a possible position at the closest distance to this point compared to all other navigation meshes from other navigation regions that are also registered on the navigation map of the provided region. If multiple navigation meshes have positions at equal distance the navigation region whose polygons are processed first wins the ownership. Polygons are processed in the same order that navigation regions were registered on the NavigationServer. @@ -354,55 +354,55 @@ - - + + Sets the [code]enter_cost[/code] for this [code]region[/code]. - - + + Sets the map for the region. - - + + Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer3D.map_get_path]). - - + + Sets the navigation mesh for the region. - - + + Sets the global transformation for the region. - - + + Sets the [code]travel_cost[/code] for this [code]region[/code]. - + Control activation of this server. @@ -410,7 +410,7 @@ - + Emitted when a navigation map is updated, when a region moves or is modified. diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index 863686926a..d84509ca8f 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -11,15 +11,15 @@ - + Returns the size of the margin on the specified [enum Side]. - - + + Sets the size of the margin on the specified [enum Side] to [code]value[/code] pixels. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 8cc8498609..1436123e94 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -46,7 +46,7 @@ - + Called when there is an input event. The input event propagates up through the node tree until a node consumes it. It is only called if input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_input]. @@ -57,7 +57,7 @@ - + Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the [code]delta[/code] variable should be constant. [code]delta[/code] is in seconds. It is only called if physics processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_physics_process]. @@ -67,7 +67,7 @@ - + Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the [code]delta[/code] time since the previous frame is not constant. [code]delta[/code] is in seconds. It is only called if processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process]. @@ -86,7 +86,7 @@ - + Called when an [InputEventKey] or [InputEventShortcut] hasn't been consumed by [method _input] or any GUI [Control] item. The input event propagates up through the node tree until a node consumes it. It is only called if shortcut processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_shortcut_input]. @@ -97,7 +97,7 @@ - + Called when an [InputEvent] hasn't been consumed by [method _input] or any GUI [Control] item. The input event propagates up through the node tree until a node consumes it. It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_input]. @@ -108,7 +108,7 @@ - + Called when an [InputEventKey] or [InputEventShortcut] hasn't been consumed by [method _input] or any GUI [Control] item. The input event propagates up through the node tree until a node consumes it. It is only called if unhandled key input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_key_input]. @@ -120,9 +120,9 @@ - - - + + + Adds a child node. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node. If [code]legible_unique_name[/code] is [code]true[/code], the child node will have a human-readable name based on the name of the node being instantiated instead of its type. @@ -150,8 +150,8 @@ - - + + Adds a [code]sibling[/code] node to current's node parent, at the same level as that node, right below it. If [code]legible_unique_name[/code] is [code]true[/code], the child node will have a human-readable name based on the name of the node being instantiated instead of its type. @@ -161,8 +161,8 @@ - - + + Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see [method is_inside_tree]). See notes in the description, and the group methods in [SceneTree]. The [code]persistent[/code] option is used when packing node to [PackedScene] and saving to file. Non-persistent groups aren't stored. @@ -186,7 +186,7 @@ - + Duplicates the node, returning a new node. You can fine-tune the behavior using the [code]flags[/code] (see [enum DuplicateFlags]). @@ -195,9 +195,9 @@ - - - + + + Finds the first descendant of this node whose name matches [code]pattern[/code] as in [method String.match]. [code]pattern[/code] does not match against the full path, just against individual node names. It is case-sensitive, with [code]"*"[/code] matching zero or more characters and [code]"?"[/code] matching any single character except [code]"."[/code]). @@ -210,10 +210,10 @@ - - - - + + + + Finds descendants of this node whose name matches [code]pattern[/code] as in [method String.match], and/or type matches [code]type[/code] as in [method Object.is_class]. [code]pattern[/code] does not match against the full path, just against individual node names. It is case-sensitive, with [code]"*"[/code] matching zero or more characters and [code]"?"[/code] matching any single character except [code]"."[/code]). @@ -227,7 +227,7 @@ - + Finds the first parent of the current node whose name matches [code]pattern[/code] as in [method String.match]. [code]pattern[/code] does not match against the full path, just against individual node names. It is case-sensitive, with [code]"*"[/code] matching zero or more characters and [code]"?"[/code] matching any single character except [code]"."[/code]). @@ -236,8 +236,8 @@ - - + + Returns a child node by its index (see [method get_child_count]). This method is often used for iterating all children of a node. Negative indices access the children from the last one. @@ -247,7 +247,7 @@ - + Returns the number of child nodes. If [code]include_internal[/code] is [code]false[/code], internal children aren't counted (see [code]internal[/code] parameter in [method add_child]). @@ -255,7 +255,7 @@ - + Returns an array of references to node's children. If [code]include_internal[/code] is [code]false[/code], the returned array won't include internal children (see [code]internal[/code] parameter in [method add_child]). @@ -278,7 +278,7 @@ - + Returns the node's order in the scene tree branch. For example, if called on the first child node the position is [code]0[/code]. If [code]include_internal[/code] is [code]false[/code], the index won't take internal children into account, i.e. first non-internal child will have index of 0 (see [code]internal[/code] parameter in [method add_child]). @@ -292,7 +292,7 @@ - + Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, [code]null[/code] is returned and an error is logged. Attempts to access methods on the return value will result in an "Attempt to call <method> on a null instance." error. [b]Note:[/b] Fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). @@ -326,7 +326,7 @@ - + Fetches a node and one of its resources as specified by the [NodePath]'s subname (e.g. [code]Area2D/CollisionShape2D:shape[/code]). If several nested resources are specified in the [NodePath], the last one will be fetched. The return value is an array of size 3: the first index points to the [Node] (or [code]null[/code] if not found), the second index points to the [Resource] (or [code]null[/code] if not found), and the third index is the remaining [NodePath], if any. @@ -347,7 +347,7 @@ - + Similar to [method get_node], but does not log an error if [code]path[/code] does not point to a valid [Node]. @@ -366,7 +366,7 @@ - + Returns the relative [NodePath] from this node to the specified [code]node[/code]. Both nodes must be in the same scene or the function will fail. @@ -403,21 +403,21 @@ - + Returns [code]true[/code] if the node that the [NodePath] points to exists. - + Returns [code]true[/code] if the [NodePath] points to a valid node and its subname points to a valid resource, e.g. [code]Area2D/CollisionShape2D:shape[/code]. Properties with a non-[Resource] type (e.g. nodes or primitive math types) are not considered resources. - + Returns [code]true[/code] if the given node is a direct or indirect child of the current node. @@ -430,21 +430,21 @@ - + Returns [code]true[/code] if [code]node[/code] has editable children enabled relative to this node. This method is only intended for use with editor tooling. - + Returns [code]true[/code] if the given node occurs later in the scene hierarchy than the current node. - + Returns [code]true[/code] if this node is in the specified group. See notes in the description, and the group methods in [SceneTree]. @@ -511,8 +511,8 @@ - - + + Moves a child node to a different position (order) among the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful. [b]Note:[/b] Internal children can only be moved within their expected "internal range" (see [code]internal[/code] parameter in [method add_child]). @@ -557,16 +557,16 @@ - - - + + + Calls the given method (if present) with the arguments given in [code]args[/code] on this node and recursively on all its children. If the [code]parent_first[/code] argument is [code]true[/code], the method will be called on the current node first, then on all its children. If [code]parent_first[/code] is [code]false[/code], the children will be called first. - + Notifies the current node and all its children recursively by calling [method Object.notification] on all of them. @@ -591,7 +591,7 @@ - + Removes a child node. The node is NOT deleted and must be deleted manually. [b]Note:[/b] This function may set the [member owner] of the removed Node (or its descendants) to be [code]null[/code], if that [member owner] is no longer a parent or ancestor. @@ -599,15 +599,15 @@ - + Removes a node from a group. See notes in the description, and the group methods in [SceneTree]. - - + + Replaces a node in a scene by the given one. Subscriptions that pass through this node will be lost. If [code]keep_groups[/code] is [code]true[/code], the [code]node[/code] is added to the same groups that the replaced node is in. @@ -623,7 +623,7 @@ - + Sends a remote procedure call request for the given [code]method[/code] to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same [NodePath], including the exact same node name. Behaviour depends on the RPC configuration for the given method, see [method rpc_config]. Methods are not exposed to RPCs by default. Returns [code]null[/code]. [b]Note:[/b] You can only safely use RPCs on clients after you received the [code]connected_to_server[/code] signal from the [MultiplayerAPI]. You also need to keep track of the connection state, either by the [MultiplayerAPI] signals like [code]server_disconnected[/code] or by checking [code]get_multiplayer().peer.get_connection_status() == CONNECTION_CONNECTED[/code]. @@ -631,8 +631,8 @@ - - + + Changes the RPC mode for the given [code]method[/code] with the given [code]config[/code] which should be [code]null[/code] (to disable) or a [Dictionary] in the form: [codeblock] @@ -648,45 +648,45 @@ - - + + Sends a [method rpc] to a specific peer identified by [code]peer_id[/code] (see [method MultiplayerPeer.set_target_peer]). Returns [code]null[/code]. - + Sets the folded state of the node in the Scene dock. This method is only intended for use with editor tooling. - - + + Sets the editable children state of [code]node[/code] relative to this node. This method is only intended for use with editor tooling. - - + + Sets the node's multiplayer authority to the peer with the given peer ID. The multiplayer authority is the peer that has authority over the node on the network. Useful in conjunction with [method rpc_config] and the [MultiplayerAPI]. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server). If [code]recursive[/code], the given peer is recursively set as the authority for all children of this node. - + Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a [constant NOTIFICATION_PHYSICS_PROCESS] at a fixed (usually 60 FPS, see [member Engine.physics_ticks_per_second] to change) interval (and the [method _physics_process] callback will be called if exists). Enabled automatically if [method _physics_process] is overridden. Any calls to this before [method _ready] will be ignored. - + Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal [method _physics_process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting ([method set_physics_process]). Only useful for advanced uses to manipulate built-in nodes' behavior. [b]Warning:[/b] Built-in Nodes rely on the internal processing for their own logic, so changing this value from your code may lead to unexpected behavior. Script access to this internal logic is provided for specific advanced uses, but is unsafe and not supported. @@ -694,21 +694,21 @@ - + Enables or disables processing. When a node is being processed, it will receive a [constant NOTIFICATION_PROCESS] on every drawn frame (and the [method _process] callback will be called if exists). Enabled automatically if [method _process] is overridden. Any calls to this before [method _ready] will be ignored. - + Enables or disables input processing. This is not required for GUI controls! Enabled automatically if [method _input] is overridden. Any calls to this before [method _ready] will be ignored. - + Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal [method _process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting ([method set_process]). Only useful for advanced uses to manipulate built-in nodes' behavior. [b]Warning:[/b] Built-in Nodes rely on the internal processing for their own logic, so changing this value from your code may lead to unexpected behavior. Script access to this internal logic is provided for specific advanced uses, but is unsafe and not supported. @@ -716,28 +716,28 @@ - + Enables shortcut processing. Enabled automatically if [method _shortcut_input] is overridden. Any calls to this before [method _ready] will be ignored. - + Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a [Control]). Enabled automatically if [method _unhandled_input] is overridden. Any calls to this before [method _ready] will be ignored. - + Enables unhandled key input processing. Enabled automatically if [method _unhandled_key_input] is overridden. Any calls to this before [method _ready] will be ignored. - + Sets whether this is an instance load placeholder. See [InstancePlaceholder]. @@ -781,14 +781,14 @@ - + Emitted when a child node enters the scene tree, either because it entered on its own or because this node entered with it. This signal is emitted [i]after[/i] the child node's own [constant NOTIFICATION_ENTER_TREE] and [signal tree_entered]. - + Emitted when a child node is about to exit the scene tree, either because it is being removed or freed directly, or because this node is exiting the tree. When this signal is received, the child [code]node[/code] is still in the tree and valid. This signal is emitted [i]after[/i] the child node's own [signal tree_exiting] and [constant NOTIFICATION_EXIT_TREE]. diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 2238be4ece..50392ea59a 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -13,14 +13,14 @@ - + Multiplies the current scale by the [code]ratio[/code] vector. - + Returns the angle between the node and the [code]point[/code] in radians. [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/node2d_get_angle_to.png]Illustration of the returned angle.[/url] @@ -28,65 +28,65 @@ - + Returns the [Transform2D] relative to this node's parent. - + Adds the [code]offset[/code] vector to the node's global position. - + Rotates the node so it points towards the [code]point[/code], which is expected to use global coordinates. - - + + Applies a local translation on the node's X axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is [code]false[/code], normalizes the movement. - - + + Applies a local translation on the node's Y axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is [code]false[/code], normalizes the movement. - + Applies a rotation to the node, in radians, starting from its current rotation. - + Transforms the provided local position into a position in global coordinate space. The input is expected to be local relative to the [Node2D] it is called on. e.g. Applying this method to the positions of child nodes will correctly transform their positions into the global coordinate space, but applying it to a node's own position will give an incorrect result, as it will incorporate the node's own transformation into its global position. - + Transforms the provided global position into a position in local coordinate space. The output will be local relative to the [Node2D] it is called on. e.g. It is appropriate for determining the positions of child nodes, but it is not appropriate for determining its own position relative to its parent. - + Translates the node by the given [code]offset[/code] in local coordinates. diff --git a/doc/classes/Node3D.xml b/doc/classes/Node3D.xml index ff2afd595a..6958f4f7d5 100644 --- a/doc/classes/Node3D.xml +++ b/doc/classes/Node3D.xml @@ -15,7 +15,7 @@ - + Attach a gizmo to this [code]Node3D[/code]. @@ -58,22 +58,22 @@ - - + + Rotates the global (world) transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in global coordinate system. - + Scales the global (world) transformation by the given [Vector3] scale factors. - + Moves the global (world) transformation by [Vector3] offset. The offset is in global coordinate system. @@ -110,8 +110,8 @@ - - + + Rotates the node so that the local forward axis (-Z) points toward the [code]target[/code] position. The local up axis (+Y) points as close to the [code]up[/code] vector as possible while staying perpendicular to the local forward axis. The resulting transform is orthogonal, and the scale is preserved. Non-uniform scaling may not work correctly. @@ -121,9 +121,9 @@ - - - + + + Moves the node to the specified [code]position[/code], and then rotates the node to point toward the [code]target[/code] as per [method look_at]. Operations take place in global space. @@ -136,65 +136,65 @@ - + Returns [code]true[/code] if the property identified by [code]name[/code] can be reverted to a default value. - + Returns the default value of the Node3D property with given [code]name[/code]. - - + + Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians. - - + + Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in object-local coordinate system. - + Rotates the local transformation around the X axis by angle in radians. - + Rotates the local transformation around the Y axis by angle in radians. - + Rotates the local transformation around the Z axis by angle in radians. - + Scales the local transformation by given 3D scale factors in object-local coordinate system. - + Sets whether the node uses a scale of [code](1, 1, 1)[/code] or its local transformation scale. Changes to the local transformation scale are preserved. @@ -207,30 +207,30 @@ - + Sets whether the node ignores notification that its transformation (global or local) changed. - + Sets whether the node notifies about its local transformation changes. [Node3D] will not propagate this by default. - + Sets whether the node notifies about its global and local transformation changes. [Node3D] will not propagate this by default, unless it is in the editor context and it has a valid gizmo. - - - + + + Set subgizmo selection for this node in the editor. @@ -243,21 +243,21 @@ - + Transforms [code]local_point[/code] from this node's local space to world space. - + Transforms [code]global_point[/code] from world space to this node's local space. - + Changes the node's position by the given offset [Vector3]. Note that the translation [code]offset[/code] is affected by the node's scale, so if scaled by e.g. [code](10, 1, 1)[/code], a translation by an offset of [code](2, 0, 0)[/code] would actually add 20 ([code]2 * 10[/code]) to the X coordinate. @@ -265,7 +265,7 @@ - + Changes the node's position by the given offset [Vector3] in local space. diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index d9e0680a38..edea501d6e 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -35,14 +35,14 @@ - + Constructs a [NodePath] as a copy of the given [NodePath]. [code]NodePath("example")[/code] is equivalent to [code]^"example"[/code]. - + Creates a NodePath from a string, e.g. [code]"Path2D/PathFollow2D/Sprite2D:texture:size"[/code]. A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, [code]"."[/code] and [code]".."[/code] indicate the current node and its parent. The "subnames" optionally included after the path to the target node can point to resources or properties, and can also be nested. @@ -111,7 +111,7 @@ - + Gets the node name indicated by [code]idx[/code] (0 to [method get_name_count] - 1). [codeblocks] @@ -139,7 +139,7 @@ - + Gets the resource or property name indicated by [code]idx[/code] (0 to [method get_subname_count]). [codeblocks] @@ -185,13 +185,13 @@ - + - + diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 75cd52787a..a1f1e9f0d6 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -12,8 +12,8 @@ - - + + Displays a modal dialog box using the host OS' facilities. Execution is blocked until the dialog is closed. @@ -33,14 +33,14 @@ - + Crashes the engine (or the editor if called within a [code]@tool[/code] script). This should [i]only[/i] be used for testing the system's crash handler, not for any other purpose. For general error reporting, use (in order of preference) [method @GDScript.assert], [method @GlobalScope.push_error] or [method alert]. See also [method kill]. - + Creates a new instance of Godot that runs independently. The [code]arguments[/code] are used in the given order and separated by a space. If the process creation succeeds, the method will return the new process ID, which you can use to monitor the process (and potentially terminate it with [method kill]). If the process creation fails, the method will return [code]-1[/code]. @@ -49,9 +49,9 @@ - - - + + + Creates a new process that runs independently of Godot. It will not terminate if Godot terminates. The path specified in [code]path[/code] must exist and be executable file or macOS .app bundle. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space. On Windows, if [code]open_console[/code] is [code]true[/code] and the process is a console app, a new terminal window will be opened. This is ignored on other platforms. @@ -72,7 +72,7 @@ - + Delays execution of the current thread by [code]msec[/code] milliseconds. [code]msec[/code] must be greater than or equal to [code]0[/code]. Otherwise, [method delay_msec] will do nothing and will print an error message. [b]Note:[/b] [method delay_msec] is a [i]blocking[/i] way to delay code execution. To delay code execution in a non-blocking way, see [method SceneTree.create_timer]. Awaiting with [method SceneTree.create_timer] will delay the execution of code placed below the [code]await[/code] without affecting the rest of the project (or editor, for [EditorPlugin]s and [EditorScript]s). @@ -81,7 +81,7 @@ - + Delays execution of the current thread by [code]usec[/code] microseconds. [code]usec[/code] must be greater than or equal to [code]0[/code]. Otherwise, [method delay_usec] will do nothing and will print an error message. [b]Note:[/b] [method delay_usec] is a [i]blocking[/i] way to delay code execution. To delay code execution in a non-blocking way, see [method SceneTree.create_timer]. Awaiting with [method SceneTree.create_timer] will delay the execution of code placed below the [code]await[/code] without affecting the rest of the project (or editor, for [EditorPlugin]s and [EditorScript]s). @@ -90,7 +90,7 @@ - + Dumps the memory allocation ringlist to a file (only works in debug). Entry format per line: "Address - Size - Description". @@ -98,7 +98,7 @@ - + Dumps all used resources to file (only works in debug). Entry format per line: "Resource Type : Resource Location". @@ -107,11 +107,11 @@ - - - - - + + + + + Executes a command. The file specified in [code]path[/code] must exist and be executable. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space. If an [code]output[/code] [Array] is provided, the complete shell output of the process will be appended as a single [String] element in [code]output[/code]. If [code]read_stderr[/code] is [code]true[/code], the output to the standard error stream will be included too. On Windows, if [code]open_console[/code] is [code]true[/code] and the process is a console app, a new terminal window will be opened. This is ignored on other platforms. @@ -148,7 +148,7 @@ - + Returns the keycode of the given string (e.g. "Escape"). @@ -235,7 +235,7 @@ - + Returns the value of an environment variable. Returns an empty string if the environment variable doesn't exist. [b]Note:[/b] Double-check the casing of [code]variable[/code]. Environment variable names are case-sensitive on all platforms except Windows. @@ -257,7 +257,7 @@ - + Returns the given keycode as a string (e.g. Return values: [code]"Escape"[/code], [code]"Shift+Escape"[/code]). See also [member InputEventKey.keycode] and [method InputEventKey.get_keycode_with_modifiers]. @@ -394,8 +394,8 @@ - - + + Returns the actual path to commonly used folders across different platforms. Available locations are specified in [enum SystemDir]. [b]Note:[/b] This method is implemented on Android, Linux, macOS and Windows. @@ -404,9 +404,9 @@ - - - + + + Returns path to the system font file with [code]font_name[/code] and style. Return empty string if no matching fonts found. [b]Note:[/b] This method is implemented on iOS, Linux, macOS and Windows. @@ -449,7 +449,7 @@ - + Returns [code]true[/code] if the environment variable with the name [code]variable[/code] exists. [b]Note:[/b] Double-check the casing of [code]variable[/code]. Environment variable names are case-sensitive on all platforms except Windows. @@ -457,7 +457,7 @@ - + Returns [code]true[/code] if the feature for the given feature tag is supported in the currently running instance, depending on the platform, build, etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. Refer to the [url=$DOCS_URL/getting_started/workflow/export/feature_tags.html]Feature Tags[/url] documentation for more details. [b]Note:[/b] Tag names are case-sensitive. @@ -473,14 +473,14 @@ - + Returns [code]true[/code] if the input keycode corresponds to a Unicode character. - + Returns [code]true[/code] if the child process ID ([code]pid[/code]) is still running or [code]false[/code] if it has terminated. Must be a valid ID generated from [method create_process]. @@ -507,7 +507,7 @@ - + Kill (terminate) the process identified by the given process ID ([code]pid[/code]), e.g. the one returned by [method execute] in non-blocking mode. See also [method crash]. [b]Note:[/b] This method can also be used to kill processes that were not spawned by the game. @@ -516,7 +516,7 @@ - + Moves the file or directory to the system's recycle bin. See also [method Directory.remove]. The method takes only global paths, so you may need to use [method ProjectSettings.globalize_path]. Do not use it for files in [code]res://[/code] as it will not work in exported project. @@ -536,7 +536,7 @@ - + Shows all resources in the game. Optionally, the list can be written to a file by specifying a file path in [code]tofile[/code]. @@ -549,21 +549,21 @@ - + Shows the number of resources loaded by the game of the given types. - + Shows all resources currently used by the game. - + At the moment this function is only used by [code]AudioDriverOpenSL[/code] to request permission for [code]RECORD_AUDIO[/code] on Android. @@ -577,8 +577,8 @@ - - + + Sets the value of the environment variable [code]variable[/code] to [code]value[/code]. The environment variable will be set for the Godot process and any process executed with [method execute] after running [method set_environment]. The environment variable will [i]not[/i] persist to processes run after the Godot process was terminated. [b]Note:[/b] Double-check the casing of [code]variable[/code]. Environment variable names are case-sensitive on all platforms except Windows. @@ -586,8 +586,8 @@ - - + + If [code]restart[/code] is [code]true[/code], restarts the project automatically when it is exited with [method SceneTree.quit] or [constant Node.NOTIFICATION_WM_CLOSE_REQUEST]. Command line [code]arguments[/code] can be supplied. To restart the project with the same command line arguments as originally used to run the project, pass [method get_cmdline_args] as the value for [code]arguments[/code]. [method set_restart_on_exit] can be used to apply setting changes that require a restart. See also [method is_restart_on_exit_set] and [method get_restart_on_exit_arguments]. @@ -597,21 +597,21 @@ - + Sets the name of the current thread. - + Enables backup saves if [code]enabled[/code] is [code]true[/code]. - + Requests the OS to open a resource with the most appropriate program. For example: - [code]OS.shell_open("C:\\Users\name\Downloads")[/code] on Windows opens the file explorer at the user's Downloads folder. diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 061b32bfdf..824da0591e 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -36,7 +36,7 @@ - + Virtual method which can be overridden to customize the return value of [method get]. Returns the given property. Returns [code]null[/code] if the [code]property[/code] does not exist. @@ -59,15 +59,15 @@ - + Called whenever the object receives a notification, which is identified in [code]what[/code] by a constant. The base [Object] has two constants [constant NOTIFICATION_POSTINITIALIZE] and [constant NOTIFICATION_PREDELETE], but subclasses such as [Node] define a lot more notifications which are also received by this method. - - + + Virtual method which can be overridden to customize the return value of [method set]. Sets a property. Returns [code]true[/code] if the [code]property[/code] exists. @@ -82,15 +82,15 @@ - - + + Adds a user-defined [code]signal[/code]. Arguments are optional, but can be added as an [Array] of dictionaries, each containing [code]name: String[/code] and [code]type: int[/code] (see [enum Variant.Type]) entries. - + Calls the [code]method[/code] on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: [codeblocks] @@ -108,7 +108,7 @@ - + Calls the [code]method[/code] on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: [codeblocks] @@ -126,8 +126,8 @@ - - + + Calls the [code]method[/code] on the object and returns the result. Contrarily to [method call], this method does not support a variable number of arguments but expects all parameters to be via a single [Array]. [codeblocks] @@ -150,9 +150,9 @@ - - - + + + Connects a [code]signal[/code] to a [code]callable[/code]. Use [code]flags[/code] to set deferred or one-shot connections. See [enum ConnectFlags] constants. A signal can only be connected once to a [Callable]. It will print an error if already connected, unless the signal was connected with [constant CONNECT_REFERENCE_COUNTED]. To avoid this, first, use [method is_connected] to check for existing connections. @@ -291,8 +291,8 @@ - - + + Disconnects a [code]signal[/code] from a given [code]callable[/code]. If you try to disconnect a connection that does not exist, the method will print an error. Use [method is_connected] to ensure that the connection exists. @@ -300,7 +300,7 @@ - + Emits the given [code]signal[/code]. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: [codeblocks] @@ -323,7 +323,7 @@ - + Returns the [Variant] value of the given [code]property[/code]. If the [code]property[/code] doesn't exist, this will return [code]null[/code]. [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase). @@ -348,7 +348,7 @@ - + Gets the object's property indexed by the given [NodePath]. The node path should be relative to the current object and can use the colon character ([code]:[/code]) to access nested properties. Examples: [code]"position:x"[/code] or [code]"material:next_pass:blend_mode"[/code]. [b]Note:[/b] Even though the method takes [NodePath] argument, it doesn't support actual paths to [Node]s in the scene tree, only colon-separated sub-property paths. For the purpose of nodes, use [method Node.get_node_and_resource] instead. @@ -363,8 +363,8 @@ - - + + Returns the object's metadata entry for the given [code]name[/code]. Throws error if the entry does not exist, unless [code]default[/code] is not [code]null[/code] (in which case the default value will be returned). @@ -397,7 +397,7 @@ - + Returns an [Array] of connections for the given [code]signal[/code]. @@ -410,28 +410,28 @@ - + Returns [code]true[/code] if a metadata entry is found with the given [code]name[/code]. - + Returns [code]true[/code] if the object contains the given [code]method[/code]. - + Returns [code]true[/code] if the given [code]signal[/code] exists. - + Returns [code]true[/code] if the given user-defined [code]signal[/code] exists. Only signals added using [method add_user_signal] are taken into account. @@ -444,7 +444,7 @@ - + Returns [code]true[/code] if the object inherits from the given [code]class[/code]. See also [method get_class]. [b]Note:[/b] [method is_class] does not take [code]class_name[/code] declarations into account. If the object has a [code]class_name[/code] defined, [method is_class] will return [code]false[/code] for that name. @@ -452,8 +452,8 @@ - - + + Returns [code]true[/code] if a connection exists for a given [code]signal[/code] and [code]callable[/code]. @@ -466,8 +466,8 @@ - - + + Send a given notification to the object, which will also trigger a call to the [method _notification] method of all classes that the object inherits from. If [code]reversed[/code] is [code]true[/code], [method _notification] is called first on the object's own class, and then up to its successive parent classes. If [code]reversed[/code] is [code]false[/code], [method _notification] is called first on the highest ancestor ([Object] itself), and then down to its successive inheriting classes. @@ -481,15 +481,15 @@ - + Removes a given entry from the object's metadata. See also [method set_meta]. - - + + Assigns a new value to the given property. If the [code]property[/code] does not exist or the given value's type doesn't match, nothing will happen. [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase). @@ -497,15 +497,15 @@ - + If set to [code]true[/code], signal emission is blocked. - - + + Assigns a new value to the given property, after the current frame's physics step. This is equivalent to calling [method set] via [method call_deferred], i.e. [code]call_deferred("set", property, value)[/code]. [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase). @@ -513,8 +513,8 @@ - - + + Assigns a new value to the property identified by the [NodePath]. The node path should be relative to the current object and can use the colon character ([code]:[/code]) to access nested properties. Example: [codeblocks] @@ -535,15 +535,15 @@ - + Defines whether the object can translate strings (with calls to [method tr]). Enabled by default. - - + + Adds, changes or removes a given entry in the object's metadata. Metadata are serialized and can take any [Variant] value. To remove a given entry from the object's metadata, use [method remove_meta]. Metadata is also removed if its value is set to [code]null[/code]. This means you can also use [code]set_meta("name", null)[/code] to remove metadata for [code]"name"[/code]. @@ -551,7 +551,7 @@ - + Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality. If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script's [method _init] method will be called. @@ -566,8 +566,8 @@ - - + + Translates a message using translation catalogs configured in the Project Settings. An additional context could be used to specify the translation context. Only works if message translation is enabled (which it is by default), otherwise it returns the [code]message[/code] unchanged. See [method set_message_translation]. @@ -576,10 +576,10 @@ - - - - + + + + Translates a message involving plurals using translation catalogs configured in the Project Settings. An additional context could be used to specify the translation context. Only works if message translation is enabled (which it is by default), otherwise it returns the [code]message[/code] or [code]plural_message[/code] unchanged. See [method set_message_translation]. diff --git a/doc/classes/OccluderInstance3D.xml b/doc/classes/OccluderInstance3D.xml index 08d12341cd..556ff07267 100644 --- a/doc/classes/OccluderInstance3D.xml +++ b/doc/classes/OccluderInstance3D.xml @@ -15,15 +15,15 @@ - + Returns whether or not the specified layer of the [member bake_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member bake_mask], given a [code]layer_number[/code] between 1 and 32. diff --git a/doc/classes/OptimizedTranslation.xml b/doc/classes/OptimizedTranslation.xml index 68765f9862..54ebfd3146 100644 --- a/doc/classes/OptimizedTranslation.xml +++ b/doc/classes/OptimizedTranslation.xml @@ -11,7 +11,7 @@ - + Generates and sets an optimized translation from the given [Translation] resource. diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 737662fe69..9e476bd05b 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -13,24 +13,24 @@ - - - + + + Adds an item, with a [code]texture[/code] icon, text [code]label[/code] and (optionally) [code]id[/code]. If no [code]id[/code] is passed, the item index will be used as the item's ID. New items are appended at the end. - - + + Adds an item, with text [code]label[/code] and (optionally) [code]id[/code]. If no [code]id[/code] is passed, the item index will be used as the item's ID. New items are appended at the end. - + Adds a separator to the list of items. Separators help to group items, and can optionally be given a [code]text[/code] header. A separator also gets an index assigned, and is appended at the end of the item list. @@ -43,42 +43,42 @@ - + Returns the icon of the item at index [code]idx[/code]. - + Returns the ID of the item at index [code]idx[/code]. - + Returns the index of the item with the given [code]id[/code]. - + Retrieves the metadata of an item. Metadata may be any type and can be used to store extra information about an item, such as an external string ID. - + Returns the text of the item at index [code]idx[/code]. - + Returns the tooltip of the item at index [code]idx[/code]. @@ -92,7 +92,7 @@ - + @@ -115,27 +115,27 @@ - + Returns [code]true[/code] if the item at index [code]idx[/code] is disabled. - + - + Removes the item at index [code]idx[/code]. - + Selects an item by index and makes it the current item. This will work even if the item is disabled. Passing [code]-1[/code] as the index deselects any currently selected item. @@ -143,8 +143,8 @@ - - + + Sets whether the item at index [code]idx[/code] is disabled. Disabled items are drawn differently in the dropdown and are not selectable by the user. If the current selected item is set as disabled, it will remain selected. @@ -152,40 +152,40 @@ - - + + Sets the icon of the item at index [code]idx[/code]. - - + + Sets the ID of the item at index [code]idx[/code]. - - + + Sets the metadata of an item. Metadata may be of any type and can be used to store extra information about an item, such as an external string ID. - - + + Sets the text of the item at index [code]idx[/code]. - - + + Sets the tooltip of the item at index [code]idx[/code]. @@ -208,13 +208,13 @@ - + Emitted when the user navigates to an item using the [code]ui_up[/code] or [code]ui_down[/code] actions. The index of the item selected is passed as argument. - + Emitted when the current item has been changed by the user. The index of the item selected is passed as argument. diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml index 3b84128123..3083ea849b 100644 --- a/doc/classes/PCKPacker.xml +++ b/doc/classes/PCKPacker.xml @@ -26,26 +26,26 @@ - - - + + + Adds the [code]source_path[/code] file to the current PCK package at the [code]pck_path[/code] internal path (should start with [code]res://[/code]). - + Writes the files specified using all [method add_file] calls since the last flush. If [code]verbose[/code] is [code]true[/code], a list of files added will be printed to the console for easier debugging. - - - - + + + + Creates a new PCK file with the name [code]pck_name[/code]. The [code].pck[/code] file extension isn't added automatically, so it should be part of [code]pck_name[/code] (even though it's not required). diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index 3af3bb8697..f7210122e6 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -17,14 +17,14 @@ - + Constructs a [PackedByteArray] as a copy of the given [PackedByteArray]. - + Constructs a new [PackedByteArray]. Optionally, you can pass in a generic [Array] that will be converted. @@ -33,22 +33,22 @@ - + Appends an element at the end of the array (alias of [method push_back]). - + Appends a [PackedByteArray] at the end of this array. - - + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -56,110 +56,110 @@ - + Returns a new [PackedByteArray] with the data compressed. Set the compression mode using one of [enum File.CompressionMode]'s constants. - + Returns the number of times an element is in the array. - + - + - + - + - + - + - + - + - + - + - + - - + + - - + + - - + + 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 a new [PackedByteArray] with the data decompressed. Set the compression mode using one of [enum File.CompressionMode]'s constants. [b]This method only accepts gzip and deflate compression modes.[/b] This method is potentially slower than [code]decompress[/code], as it may have to re-allocate its output buffer multiple times while decompressing, whereas [code]decompress[/code] knows it's output buffer size from the beginning. @@ -174,100 +174,100 @@ - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - - + + + - + Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. - - + + Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. @@ -298,15 +298,15 @@ - + Returns [code]true[/code] if the array contains [code]value[/code]. - - + + @@ -328,8 +328,8 @@ - - + + 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]). @@ -342,21 +342,21 @@ - + 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. @@ -369,16 +369,16 @@ - - + + Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. - - + + Changes the byte at the given index. @@ -391,8 +391,8 @@ - - + + Returns the slice of the [PackedByteArray], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedByteArray]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -441,25 +441,25 @@ - + - + - + - + diff --git a/doc/classes/PackedColorArray.xml b/doc/classes/PackedColorArray.xml index 12a553af49..dd9ada44fb 100644 --- a/doc/classes/PackedColorArray.xml +++ b/doc/classes/PackedColorArray.xml @@ -17,14 +17,14 @@ - + Constructs a [PackedColorArray] as a copy of the given [PackedColorArray]. - + Constructs a new [PackedColorArray]. Optionally, you can pass in a generic [Array] that will be converted. @@ -33,22 +33,22 @@ - + Appends an element at the end of the array (alias of [method push_back]). - + Appends a [PackedColorArray] at the end of this array. - - + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -56,7 +56,7 @@ - + Returns the number of times an element is in the array. @@ -69,30 +69,30 @@ - + Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. - - + + Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. - + Returns [code]true[/code] if the array contains [code]value[/code]. - - + + 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]). @@ -105,21 +105,21 @@ - + 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. @@ -132,16 +132,16 @@ - - + + Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. - - + + Changes the [Color] at the given index. @@ -154,8 +154,8 @@ - - + + Returns the slice of the [PackedColorArray], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedColorArray]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -177,25 +177,25 @@ - + - + - + - + diff --git a/doc/classes/PackedDataContainer.xml b/doc/classes/PackedDataContainer.xml index cba7269ccf..5035c8dee4 100644 --- a/doc/classes/PackedDataContainer.xml +++ b/doc/classes/PackedDataContainer.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/PackedFloat32Array.xml b/doc/classes/PackedFloat32Array.xml index 0a114e6c06..ee5497cb1b 100644 --- a/doc/classes/PackedFloat32Array.xml +++ b/doc/classes/PackedFloat32Array.xml @@ -18,14 +18,14 @@ - + Constructs a [PackedFloat32Array] as a copy of the given [PackedFloat32Array]. - + Constructs a new [PackedFloat32Array]. Optionally, you can pass in a generic [Array] that will be converted. @@ -34,22 +34,22 @@ - + Appends an element at the end of the array (alias of [method push_back]). - + Appends a [PackedFloat32Array] at the end of this array. - - + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -57,7 +57,7 @@ - + Returns the number of times an element is in the array. @@ -70,30 +70,30 @@ - + Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. - - + + Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. - + Returns [code]true[/code] if the array contains [code]value[/code]. - - + + 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]). @@ -106,21 +106,21 @@ - + 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. @@ -133,16 +133,16 @@ - - + + Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. - - + + Changes the float at the given index. @@ -155,8 +155,8 @@ - - + + Returns the slice of the [PackedFloat32Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedFloat32Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -180,25 +180,25 @@ - + - + - + - + diff --git a/doc/classes/PackedFloat64Array.xml b/doc/classes/PackedFloat64Array.xml index 0327559f5b..2cc8eff059 100644 --- a/doc/classes/PackedFloat64Array.xml +++ b/doc/classes/PackedFloat64Array.xml @@ -18,14 +18,14 @@ - + Constructs a [PackedFloat64Array] as a copy of the given [PackedFloat64Array]. - + Constructs a new [PackedFloat64Array]. Optionally, you can pass in a generic [Array] that will be converted. @@ -34,22 +34,22 @@ - + Appends an element at the end of the array (alias of [method push_back]). - + Appends a [PackedFloat64Array] at the end of this array. - - + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -57,7 +57,7 @@ - + Returns the number of times an element is in the array. @@ -70,30 +70,30 @@ - + Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. - - + + Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. - + Returns [code]true[/code] if the array contains [code]value[/code]. - - + + 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]). @@ -106,21 +106,21 @@ - + 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. @@ -133,16 +133,16 @@ - - + + Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. - - + + Changes the float at the given index. @@ -155,8 +155,8 @@ - - + + Returns the slice of the [PackedFloat64Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedFloat64Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -180,25 +180,25 @@ - + - + - + - + diff --git a/doc/classes/PackedInt32Array.xml b/doc/classes/PackedInt32Array.xml index f8b606d266..70f3f1d180 100644 --- a/doc/classes/PackedInt32Array.xml +++ b/doc/classes/PackedInt32Array.xml @@ -18,14 +18,14 @@ - + Constructs a [PackedInt32Array] as a copy of the given [PackedInt32Array]. - + Constructs a new [PackedInt32Array]. Optionally, you can pass in a generic [Array] that will be converted. @@ -34,22 +34,22 @@ - + Appends an element at the end of the array (alias of [method push_back]). - + Appends a [PackedInt32Array] at the end of this array. - - + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -57,7 +57,7 @@ - + Returns the number of times an element is in the array. @@ -70,30 +70,30 @@ - + Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. - - + + Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. - + Returns [code]true[/code] if the array contains [code]value[/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]). @@ -106,21 +106,21 @@ - + 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. @@ -133,16 +133,16 @@ - - + + Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. - - + + Changes the integer at the given index. @@ -155,8 +155,8 @@ - - + + Returns the slice of the [PackedInt32Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedInt32Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -180,25 +180,25 @@ - + - + - + - + diff --git a/doc/classes/PackedInt64Array.xml b/doc/classes/PackedInt64Array.xml index ea3e304d35..5d590f02a4 100644 --- a/doc/classes/PackedInt64Array.xml +++ b/doc/classes/PackedInt64Array.xml @@ -18,14 +18,14 @@ - + Constructs a [PackedInt64Array] as a copy of the given [PackedInt64Array]. - + Constructs a new [PackedInt64Array]. Optionally, you can pass in a generic [Array] that will be converted. @@ -34,22 +34,22 @@ - + Appends an element at the end of the array (alias of [method push_back]). - + Appends a [PackedInt64Array] at the end of this array. - - + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -57,7 +57,7 @@ - + Returns the number of times an element is in the array. @@ -70,30 +70,30 @@ - + Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. - - + + Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. - + Returns [code]true[/code] if the array contains [code]value[/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]). @@ -106,21 +106,21 @@ - + 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. @@ -133,16 +133,16 @@ - - + + Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. - - + + Changes the integer at the given index. @@ -155,8 +155,8 @@ - - + + Returns the slice of the [PackedInt64Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedInt64Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -180,25 +180,25 @@ - + - + - + - + diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index 821fc1ae95..c7fe7d8c37 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -90,14 +90,14 @@ - + Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers a [constant Node.NOTIFICATION_INSTANCED] notification on the root node. - + Pack will ignore any sub-nodes not owned by given node. See [member Node.owner]. diff --git a/doc/classes/PackedStringArray.xml b/doc/classes/PackedStringArray.xml index a4653344f0..0e6afec2d9 100644 --- a/doc/classes/PackedStringArray.xml +++ b/doc/classes/PackedStringArray.xml @@ -24,14 +24,14 @@ - + Constructs a [PackedStringArray] as a copy of the given [PackedStringArray]. - + Constructs a new [PackedStringArray]. Optionally, you can pass in a generic [Array] that will be converted. @@ -40,22 +40,22 @@ - + Appends an element at the end of the array (alias of [method push_back]). - + Appends a [PackedStringArray] at the end of this array. - - + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -63,7 +63,7 @@ - + Returns the number of times an element is in the array. @@ -76,30 +76,30 @@ - + Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. - - + + Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. - + Returns [code]true[/code] if the array contains [code]value[/code]. - - + + 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]). @@ -112,21 +112,21 @@ - + 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. @@ -139,16 +139,16 @@ - - + + Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. - - + + Changes the [String] at the given index. @@ -161,8 +161,8 @@ - - + + Returns the slice of the [PackedStringArray], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedStringArray]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -184,25 +184,25 @@ - + - + - + - + diff --git a/doc/classes/PackedVector2Array.xml b/doc/classes/PackedVector2Array.xml index 8f3e5d173d..97ed8cdc57 100644 --- a/doc/classes/PackedVector2Array.xml +++ b/doc/classes/PackedVector2Array.xml @@ -18,14 +18,14 @@ - + Constructs a [PackedVector2Array] as a copy of the given [PackedVector2Array]. - + Constructs a new [PackedVector2Array]. Optionally, you can pass in a generic [Array] that will be converted. @@ -34,22 +34,22 @@ - + Appends an element at the end of the array (alias of [method push_back]). - + Appends a [PackedVector2Array] at the end of this array. - - + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -57,7 +57,7 @@ - + Returns the number of times an element is in the array. @@ -70,30 +70,30 @@ - + Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. - - + + Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. - + Returns [code]true[/code] if the array contains [code]value[/code]. - - + + 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]). @@ -106,21 +106,21 @@ - + 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. @@ -133,16 +133,16 @@ - - + + Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. - - + + Changes the [Vector2] at the given index. @@ -155,8 +155,8 @@ - - + + Returns the slice of the [PackedVector2Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedVector2Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -178,31 +178,31 @@ - + - + - + - + - + diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml index 1207293c32..102d68a22c 100644 --- a/doc/classes/PackedVector3Array.xml +++ b/doc/classes/PackedVector3Array.xml @@ -17,14 +17,14 @@ - + Constructs a [PackedVector3Array] as a copy of the given [PackedVector3Array]. - + Constructs a new [PackedVector3Array]. Optionally, you can pass in a generic [Array] that will be converted. @@ -33,22 +33,22 @@ - + Appends an element at the end of the array (alias of [method push_back]). - + Appends a [PackedVector3Array] at the end of this array. - - + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. @@ -56,7 +56,7 @@ - + Returns the number of times an element is in the array. @@ -69,30 +69,30 @@ - + Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. - - + + Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. - + Returns [code]true[/code] if the array contains [code]value[/code]. - - + + 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]). @@ -105,21 +105,21 @@ - + 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. @@ -132,16 +132,16 @@ - - + + Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. - - + + Changes the [Vector3] at the given index. @@ -154,8 +154,8 @@ - - + + Returns the slice of the [PackedVector3Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedVector3Array]. The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). @@ -177,31 +177,31 @@ - + - + - + - + - + diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index 40fa90e4da..6bfaa71838 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -30,7 +30,7 @@ - + Gets a Variant. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. @@ -38,15 +38,15 @@ - + Sends a raw packet. - - + + Sends a [Variant] as a packet. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code). diff --git a/doc/classes/PacketPeerDTLS.xml b/doc/classes/PacketPeerDTLS.xml index ee45c42498..319740e76b 100644 --- a/doc/classes/PacketPeerDTLS.xml +++ b/doc/classes/PacketPeerDTLS.xml @@ -13,10 +13,10 @@ - - - - + + + + Connects a [code]peer[/code] beginning the DTLS handshake using the underlying [PacketPeerUDP] which must be connected (see [method PacketPeerUDP.connect_to_host]). If [code]validate_certs[/code] is [code]true[/code], [PacketPeerDTLS] will validate that the certificate presented by the remote peer and match it with the [code]for_hostname[/code] argument. You can specify a custom [X509Certificate] to use for validation via the [code]valid_certificate[/code] argument. diff --git a/doc/classes/PacketPeerExtension.xml b/doc/classes/PacketPeerExtension.xml index 7cf5ef3504..28263b3f59 100644 --- a/doc/classes/PacketPeerExtension.xml +++ b/doc/classes/PacketPeerExtension.xml @@ -19,15 +19,15 @@ - - + + - - + + diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 7c6622be3c..bcd9f3fb46 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -12,9 +12,9 @@ - - - + + + Binds this [PacketPeerUDP] to the specified [code]port[/code] and [code]address[/code] with a buffer size [code]recv_buf_size[/code], allowing it to receive incoming packets. If [code]address[/code] is set to [code]"*"[/code] (default), the peer will be bound on all available addresses (both IPv4 and IPv6). @@ -30,8 +30,8 @@ - - + + Calling this method connects this UDP peer to the given [code]host[/code]/[code]port[/code] pair. UDP is in reality connectionless, so this option only means that incoming packets from different addresses are automatically discarded, and that outgoing packets are always sent to the connected address (future calls to [method set_dest_address] are not allowed). This method does not send any data to the remote peer, to do that, use [method PacketPeer.put_var] or [method PacketPeer.put_packet] as usual. See also [UDPServer]. [b]Note:[/b] Connecting to the remote peer does not help to protect from malicious attacks like IP spoofing, etc. Think about using an encryption technique like SSL or DTLS if you feel like your application is transferring sensitive information. @@ -69,8 +69,8 @@ - - + + Joins the multicast group specified by [code]multicast_address[/code] using the interface identified by [code]interface_name[/code]. You can join the same multicast group with multiple interfaces. Use [method IP.get_local_interfaces] to know which are available. @@ -79,15 +79,15 @@ - - + + Removes the interface identified by [code]interface_name[/code] from the multicast group specified by [code]multicast_address[/code]. - + Enable or disable sending of broadcast packets (e.g. [code]set_dest_address("255.255.255.255", 4343)[/code]. This option is disabled by default. [b]Note:[/b] Some Android devices might require the [code]CHANGE_WIFI_MULTICAST_STATE[/code] permission and this option to be enabled to receive broadcast packets too. @@ -95,8 +95,8 @@ - - + + Sets the destination address and port for sending packets and variables. A hostname will be resolved using DNS if needed. [b]Note:[/b] [method set_broadcast_enabled] must be enabled before sending packets to a broadcast address (e.g. [code]255.255.255.255[/code]). diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 7badd826d9..fe4caaa10c 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -13,60 +13,60 @@ - + Returns the maximum value range for the given parameter. - + Returns the minimum value range for the given parameter. - + Returns the [Texture2D] used by the specified parameter. - + Returns [code]true[/code] if the specified particle flag is enabled. See [enum ParticleFlags] for options. - - + + Sets the maximum value range for the given parameter. - - + + Sets the minimum value range for the given parameter. - - + + Sets the [Texture2D] for the specified [enum Parameter]. - - + + If [code]true[/code], enables the specified particle flag. See [enum ParticleFlags] for options. diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml index 01da9cb9a2..f61c051a52 100644 --- a/doc/classes/Performance.xml +++ b/doc/classes/Performance.xml @@ -15,9 +15,9 @@ - - - + + + Adds a custom monitor with the name [code]id[/code]. You can specify the category of the monitor using slash delimiters in [code]id[/code] (for example: [code]"Game/NumberOfNPCs"[/code]). If there is more than one slash delimiter, then the default category is used. The default category is [code]"Custom"[/code]. Prints an error if given [code]id[/code] is already present. [codeblocks] @@ -73,7 +73,7 @@ - + Returns the value of custom monitor with given [code]id[/code]. The callable is called to get the value of custom monitor. See also [method has_custom_monitor]. Prints an error if the given [code]id[/code] is absent. @@ -86,7 +86,7 @@ - + Returns the value of one of the available built-in monitors. You should provide one of the [enum Monitor] constants as the argument, like this: [codeblocks] @@ -108,14 +108,14 @@ - + Returns [code]true[/code] if custom monitor with the given [code]id[/code] is present, [code]false[/code] otherwise. - + Removes the custom monitor with given [code]id[/code]. Prints an error if the given [code]id[/code] is already absent. diff --git a/doc/classes/PhysicalBone3D.xml b/doc/classes/PhysicalBone3D.xml index 7e8cc91766..0768df31cc 100644 --- a/doc/classes/PhysicalBone3D.xml +++ b/doc/classes/PhysicalBone3D.xml @@ -9,21 +9,21 @@ - + Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it works in addition to the usual physics behavior, but the [member custom_integrator] property allows you to disable the default behavior and do fully custom force integration for a body. - + - - + + diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index 9cebd68d76..b9bffafdef 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -12,7 +12,7 @@ - + Adds a body to the list of bodies that this body can't collide with. @@ -25,9 +25,9 @@ - - - + + + Moves the body along the vector [code]distance[/code]. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code]. Returns a [KinematicCollision2D], which contains information about the collision when stopped, or when touching another body along the motion. @@ -37,17 +37,17 @@ - + Removes a body from the list of bodies that this body can't collide with. - - - - + + + + Checks for collisions without moving the body. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code]. Virtually sets the node's position, scale and rotation to that of the given [Transform2D], then tries to move the body along the vector [code]distance[/code]. Returns [code]true[/code] if a collision would stop the body from moving along the whole path. diff --git a/doc/classes/PhysicsBody3D.xml b/doc/classes/PhysicsBody3D.xml index 843f813997..4a641e5040 100644 --- a/doc/classes/PhysicsBody3D.xml +++ b/doc/classes/PhysicsBody3D.xml @@ -12,14 +12,14 @@ - + Adds a body to the list of bodies that this body can't collide with. - + Returns [code]true[/code] if the specified linear or rotational [code]axis[/code] is locked. @@ -32,10 +32,10 @@ - - - - + + + + Moves the body along the vector [code]distance[/code]. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code]. The body will stop if it collides. Returns a [KinematicCollision3D], which contains information about the collision when stopped, or when touching another body along the motion. @@ -46,26 +46,26 @@ - + Removes a body from the list of bodies that this body can't collide with. - - + + Locks or unlocks the specified linear or rotational [code]axis[/code] depending on the value of [code]lock[/code]. - - - - - + + + + + Checks for collisions without moving the body. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code]. Virtually sets the node's position, scale and rotation to that of the given [Transform3D], then tries to move the body along the vector [code]distance[/code]. Returns [code]true[/code] if a collision would stop the body from moving along the whole path. diff --git a/doc/classes/PhysicsDirectBodyState2D.xml b/doc/classes/PhysicsDirectBodyState2D.xml index 783b0488d8..56367fbf0c 100644 --- a/doc/classes/PhysicsDirectBodyState2D.xml +++ b/doc/classes/PhysicsDirectBodyState2D.xml @@ -13,7 +13,7 @@ - + Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]constant_force = Vector2(0, 0)[/code]. This is equivalent to using [method add_constant_force] at the body's center of mass. @@ -21,8 +21,8 @@ - - + + Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]constant_force = Vector2(0, 0)[/code]. [code]position[/code] is the offset from the body origin in global coordinates. @@ -30,14 +30,14 @@ - + Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]constant_torque = 0[/code]. - + Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. This is equivalent to using [method apply_force] at the body's center of mass. @@ -45,7 +45,7 @@ - + Applies a directional impulse without affecting rotation. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -54,8 +54,8 @@ - - + + Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. [code]position[/code] is the offset from the body origin in global coordinates. @@ -63,8 +63,8 @@ - - + + Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -73,14 +73,14 @@ - + Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. - + Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -102,42 +102,42 @@ - + Returns the collider's [RID]. - + Returns the collider's object id. - + Returns the collider object. This depends on how it was created (will return a scene node if such was used to create it). - + Returns the contact position in the collider. - + Returns the collider's shape index. - + Returns the linear velocity vector at the collider's contact point. @@ -151,21 +151,21 @@ - + Returns the local normal at the contact point. - + Returns the local position of the contact point. - + Returns the local shape index of the collision. @@ -178,7 +178,7 @@ - + Returns the body's velocity at the given relative position, including both translation and rotation. @@ -191,7 +191,7 @@ - + Sets the body's total constant positional forces applied during each physics update. See [method add_constant_force] and [method add_constant_central_force]. @@ -199,7 +199,7 @@ - + Sets the body's total constant rotational forces applied during each physics update. See [method add_constant_torque]. diff --git a/doc/classes/PhysicsDirectBodyState3D.xml b/doc/classes/PhysicsDirectBodyState3D.xml index 16c53b0727..b05960b035 100644 --- a/doc/classes/PhysicsDirectBodyState3D.xml +++ b/doc/classes/PhysicsDirectBodyState3D.xml @@ -13,7 +13,7 @@ - + Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]constant_force = Vector3(0, 0, 0)[/code]. This is equivalent to using [method add_constant_force] at the body's center of mass. @@ -21,8 +21,8 @@ - - + + Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]constant_force = Vector3(0, 0, 0)[/code]. [code]position[/code] is the offset from the body origin in global coordinates. @@ -30,14 +30,14 @@ - + Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]constant_torque = Vector3(0, 0, 0)[/code]. - + Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. This is equivalent to using [method apply_force] at the body's center of mass. @@ -45,7 +45,7 @@ - + Applies a directional impulse without affecting rotation. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -54,8 +54,8 @@ - - + + Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. [code]position[/code] is the offset from the body origin in global coordinates. @@ -63,8 +63,8 @@ - - + + Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -73,14 +73,14 @@ - + Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. - + Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -102,42 +102,42 @@ - + Returns the collider's [RID]. - + Returns the collider's object id. - + Returns the collider object. - + Returns the contact position in the collider. - + Returns the collider's shape index. - + Returns the linear velocity vector at the collider's contact point. @@ -151,28 +151,28 @@ - + Impulse created by the contact. Only implemented for Bullet physics. - + Returns the local normal at the contact point. - + Returns the local position of the contact point. - + Returns the local shape index of the collision. @@ -185,7 +185,7 @@ - + Returns the body's velocity at the given relative position, including both translation and rotation. @@ -198,7 +198,7 @@ - + Sets the body's total constant positional forces applied during each physics update. See [method add_constant_force] and [method add_constant_central_force]. @@ -206,7 +206,7 @@ - + Sets the body's total constant rotational forces applied during each physics update. See [method add_constant_torque]. diff --git a/doc/classes/PhysicsDirectBodyState3DExtension.xml b/doc/classes/PhysicsDirectBodyState3DExtension.xml index f0659f8f1b..ade197eadc 100644 --- a/doc/classes/PhysicsDirectBodyState3DExtension.xml +++ b/doc/classes/PhysicsDirectBodyState3DExtension.xml @@ -9,58 +9,58 @@ - + - - + + - + - + - + - - + + - - + + - + - + @@ -91,37 +91,37 @@ - + - + - + - + - + - + @@ -132,25 +132,25 @@ - + - + - + - + @@ -206,7 +206,7 @@ - + @@ -222,37 +222,37 @@ - + - + - + - + - + - + diff --git a/doc/classes/PhysicsDirectSpaceState2D.xml b/doc/classes/PhysicsDirectSpaceState2D.xml index 0b95243fe6..e5a9e5dacf 100644 --- a/doc/classes/PhysicsDirectSpaceState2D.xml +++ b/doc/classes/PhysicsDirectSpaceState2D.xml @@ -13,7 +13,7 @@ - + Checks how far a [Shape2D] can move without colliding. All the parameters for the query, including the shape and the motion, are supplied through a [PhysicsShapeQueryParameters2D] object. Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of [code][1.0, 1.0][/code] will be returned. @@ -22,8 +22,8 @@ - - + + Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time. Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in [PhysicsShapeQueryParameters2D] object, second one is in the collided shape from the physics space. @@ -31,7 +31,7 @@ - + Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. If it collides with more than one shape, the nearest one is selected. If the shape did not intersect anything, then an empty dictionary is returned instead. [b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. The returned object is a dictionary containing the following fields: @@ -45,8 +45,8 @@ - - + + Checks whether a point is inside any solid shape. Position and other parameters are defined through [PhysicsPointQueryParameters2D]. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. @@ -59,7 +59,7 @@ - + Intersects a ray in a given space. Ray position and other parameters are defined through [PhysicsRayQueryParameters2D]. The returned object is a dictionary with the following fields: [code]collider[/code]: The colliding object. @@ -73,8 +73,8 @@ - - + + Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. diff --git a/doc/classes/PhysicsDirectSpaceState3D.xml b/doc/classes/PhysicsDirectSpaceState3D.xml index 048baed345..6539edd4fe 100644 --- a/doc/classes/PhysicsDirectSpaceState3D.xml +++ b/doc/classes/PhysicsDirectSpaceState3D.xml @@ -13,7 +13,7 @@ - + Checks how far a [Shape3D] can move without colliding. All the parameters for the query, including the shape, are supplied through a [PhysicsShapeQueryParameters3D] object. Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of [code][1.0, 1.0][/code] will be returned. @@ -22,8 +22,8 @@ - - + + Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters3D] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time. Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in [PhysicsShapeQueryParameters3D] object, second one is in the collided shape from the physics space. @@ -32,7 +32,7 @@ - + Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters3D] object, against the space. If it collides with more than one shape, the nearest one is selected. The returned object is a dictionary containing the following fields: [code]collider_id[/code]: The colliding object's ID. @@ -47,8 +47,8 @@ - - + + Checks whether a point is inside any solid shape. Position and other parameters are defined through [PhysicsPointQueryParameters3D]. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. @@ -60,7 +60,7 @@ - + Intersects a ray in a given space. Ray position and other parameters are defined through [PhysicsRayQueryParameters3D]. The returned object is a dictionary with the following fields: [code]collider[/code]: The colliding object. @@ -74,8 +74,8 @@ - - + + Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters3D] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. diff --git a/doc/classes/PhysicsDirectSpaceState3DExtension.xml b/doc/classes/PhysicsDirectSpaceState3DExtension.xml index f150907963..98593012db 100644 --- a/doc/classes/PhysicsDirectSpaceState3DExtension.xml +++ b/doc/classes/PhysicsDirectSpaceState3DExtension.xml @@ -9,89 +9,89 @@ - - - - - - - - - - + + + + + + + + + + - - - - - - - - - - + + + + + + + + + + - - + + - - - - - - + + + + + + - - - - - - - - + + + + + + + + - - - - - - - - - + + + + + + + + + - - - - - - - - + + + + + + + + diff --git a/doc/classes/PhysicsRayQueryParameters2D.xml b/doc/classes/PhysicsRayQueryParameters2D.xml index 1cfc6caadf..5afd3973a0 100644 --- a/doc/classes/PhysicsRayQueryParameters2D.xml +++ b/doc/classes/PhysicsRayQueryParameters2D.xml @@ -11,10 +11,10 @@ - - - - + + + + Returns a new, pre-configured [PhysicsRayQueryParameters2D] object. Use it to quickly create query parameters using the most common options. [codeblock] diff --git a/doc/classes/PhysicsRayQueryParameters3D.xml b/doc/classes/PhysicsRayQueryParameters3D.xml index e9216a8300..620aa6bf5f 100644 --- a/doc/classes/PhysicsRayQueryParameters3D.xml +++ b/doc/classes/PhysicsRayQueryParameters3D.xml @@ -11,10 +11,10 @@ - - - - + + + + Returns a new, pre-configured [PhysicsRayQueryParameters3D] object. Use it to quickly create query parameters using the most common options. [codeblock] diff --git a/doc/classes/PhysicsServer2D.xml b/doc/classes/PhysicsServer2D.xml index 1413a3ec11..4bb44223b3 100644 --- a/doc/classes/PhysicsServer2D.xml +++ b/doc/classes/PhysicsServer2D.xml @@ -11,32 +11,32 @@ - - - - + + + + Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. - - + + - - + + Assigns the area to a descendant of [Object], so it can exist in the node tree. - + Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. @@ -49,97 +49,97 @@ - + - + Gets the instance ID of the object the area is assigned to. - - + + Returns an area parameter value. See [enum AreaParameter] for a list of available parameters. - - + + Returns the [RID] of the nth shape of an area. - + Returns the number of shapes assigned to an area. - - + + Returns the transform matrix of a shape within an area. - + Returns the space assigned to the area. - + Returns the transform matrix for an area. - - + + Removes a shape from an area. It does not delete the shape, so it can be reassigned later. - - + + - - + + Assigns the area to one or many physics layers. - - + + Sets which physics layers the area will monitor. - - + + Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area. @@ -151,75 +151,75 @@ - - + + - - - + + + Sets the value for an area parameter. See [enum AreaParameter] for a list of available parameters. - - - + + + Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID]. - - - + + + Disables a given shape in an area. - - - + + + Sets the transform matrix for an area shape. - - + + Assigns a space to the area. - - + + Sets the transform matrix for an area. - - + + Adds a body to the list of bodies exempt from collisions. - - + + Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]body_set_constant_force(body, Vector2(0, 0))[/code]. This is equivalent to using [method body_add_constant_force] at the body's center of mass. @@ -227,9 +227,9 @@ - - - + + + Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]body_set_constant_force(body, Vector2(0, 0))[/code]. [code]position[/code] is the offset from the body origin in global coordinates. @@ -237,26 +237,26 @@ - - + + Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]body_set_constant_torque(body, 0)[/code]. - - - - + + + + Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. - - + + Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. This is equivalent to using [method body_apply_force] at the body's center of mass. @@ -264,8 +264,8 @@ - - + + Applies a directional impulse without affecting rotation. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -274,9 +274,9 @@ - - - + + + Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. [code]position[/code] is the offset from the body origin in global coordinates. @@ -284,9 +284,9 @@ - - - + + + Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -295,16 +295,16 @@ - - + + Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. - - + + Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -312,22 +312,22 @@ - - + + - - + + Assigns the area to a descendant of [Object], so it can exist in the node tree. - + Removes all shapes from a body. @@ -340,27 +340,27 @@ - + - + Returns the physics layer or layers a body belongs to. - + Returns the physics layer or layers a body can collide with. - + Returns the body's total constant positional forces applied during each physics update. See [method body_add_constant_force] and [method body_add_constant_central_force]. @@ -368,7 +368,7 @@ - + Returns the body's total constant rotational forces applied during each physics update. See [method body_add_constant_torque]. @@ -376,143 +376,143 @@ - + Returns the continuous collision detection mode. - + Returns the [PhysicsDirectBodyState2D] of the body. Returns [code]null[/code] if the body is destroyed or removed from the physics space. - + Returns the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. - + Returns the body mode. - + Gets the instance ID of the object the area is assigned to. - - + + Returns the value of a body parameter. See [enum BodyParameter] for a list of available parameters. - - + + Returns the [RID] of the nth shape of a body. - + Returns the number of shapes assigned to a body. - - + + Returns the transform matrix of a body shape. - + Returns the [RID] of the space assigned to a body. - - + + Returns a body state. - + Returns whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). - - + + Removes a body from the list of bodies exempt from collisions. - - + + Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. - + Restores the default inertia and center of mass based on shapes to cancel any custom values previously set using [method body_set_param]. - - + + Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. - - + + Sets the physics layer or layers a body belongs to. - - + + Sets the physics layer or layers a body can collide with. - - + + Sets the body's total constant positional forces applied during each physics update. See [method body_add_constant_force] and [method body_add_constant_central_force]. @@ -520,8 +520,8 @@ - - + + Sets the body's total constant rotational forces applied during each physics update. See [method body_add_constant_torque]. @@ -529,8 +529,8 @@ - - + + Sets the continuous collision detection mode using one of the [enum CCDMode] constants. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. @@ -538,9 +538,9 @@ - - - + + + Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]). The force integration function takes 2 arguments: @@ -550,87 +550,87 @@ - - + + Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. - - + + Sets the body mode using one of the [enum BodyMode] constants. - - + + Sets whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). - - - + + + Sets a body parameter. See [enum BodyParameter] for a list of available parameters. - - - + + + Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID]. - - - - + + + + Enables one way collision on body if [code]enable[/code] is [code]true[/code]. - - - + + + Disables shape in body if [code]disable[/code] is [code]true[/code]. - - - + + + Sets the transform matrix for a body shape. - - + + Assigns a space to the body (see [method space_create]). - - - + + + Sets a body state using one of the [enum BodyState] constants. Note that the method doesn't take effect immediately. The state will change on the next physics frame. @@ -638,9 +638,9 @@ - - - + + + Returns [code]true[/code] if a collision would result from moving along a motion vector from a given point in space. [PhysicsTestMotionParameters2D] is passed to set motion parameters. [PhysicsTestMotionResult2D] can be passed to return additional information. @@ -667,38 +667,38 @@ - - + + Returns the value of a damped spring joint parameter. See [enum DampedSpringParam] for a list of available parameters. - - - + + + Sets a damped spring joint parameter. See [enum DampedSpringParam] for a list of available parameters. - + Destroys any of the objects created by PhysicsServer2D. If the [RID] passed is not one of the objects that can be created by PhysicsServer2D, an error will be sent to the console. - + Returns information about the current state of the 2D physics engine. See [enum ProcessInfo] for a list of available states. - + @@ -709,54 +709,54 @@ - - + + Returns the value of a joint parameter. - + Returns a joint's type (see [enum JointType]). - - - - - + + + + + - - - - - - + + + + + + - - - - + + + + - - - + + + Sets a joint parameter. See [enum JointParam] for a list of available parameters. @@ -778,29 +778,29 @@ - + Activates or deactivates the 2D physics engine. - + Returns the shape data. - + Returns a shape's type (see [enum ShapeType]). - - + + Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type]. @@ -813,39 +813,39 @@ - + Returns the state of a space, a [PhysicsDirectSpaceState2D]. This object can be used to make collision/intersection queries. - - + + Returns the value of a space parameter. - + Returns whether the space is active. - - + + Marks a space as active. It will not have an effect, unless it is assigned to an area or body. - - - + + + Sets the value for a space parameter. See [enum SpaceParameter] for a list of available parameters. diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 2e84287227..b76e9dfdf4 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -11,25 +11,25 @@ - - - - + + + + Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. - - + + Assigns the area to a descendant of [Object], so it can exist in the node tree. - + Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. @@ -42,91 +42,91 @@ - + Gets the instance ID of the object the area is assigned to. - - + + Returns an area parameter value. A list of available parameters is on the [enum AreaParameter] constants. - - + + Returns the [RID] of the nth shape of an area. - + Returns the number of shapes assigned to an area. - - + + Returns the transform matrix of a shape within an area. - + Returns the space assigned to the area. - + Returns the transform matrix for an area. - - + + Removes a shape from an area. It does not delete the shape, so it can be reassigned later. - - + + - - + + Assigns the area to one or many physics layers. - - + + Sets which physics layers the area will monitor. - - + + Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area. @@ -138,82 +138,82 @@ - - + + - - - + + + Sets the value for an area parameter. A list of available parameters is on the [enum AreaParameter] constants. - - + + Sets object pickable with rays. - - - + + + Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID]. - - - + + + - - - + + + Sets the transform matrix for an area shape. - - + + Assigns a space to the area. - - + + Sets the transform matrix for an area. - - + + Adds a body to the list of bodies exempt from collisions. - - + + Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]body_set_constant_force(body, Vector3(0, 0, 0))[/code]. This is equivalent to using [method body_add_constant_force] at the body's center of mass. @@ -221,9 +221,9 @@ - - - + + + Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]body_set_constant_force(body, Vector3(0, 0, 0))[/code]. [code]position[/code] is the offset from the body origin in global coordinates. @@ -231,26 +231,26 @@ - - + + Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]body_set_constant_torque(body, Vector3(0, 0, 0))[/code]. - - - - + + + + Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. - - + + Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. This is equivalent to using [method body_apply_force] at the body's center of mass. @@ -258,8 +258,8 @@ - - + + Applies a directional impulse without affecting rotation. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -268,9 +268,9 @@ - - - + + + Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. [code]position[/code] is the offset from the body origin in global coordinates. @@ -278,9 +278,9 @@ - - - + + + Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -289,16 +289,16 @@ - - + + Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. - - + + Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -306,15 +306,15 @@ - - + + Assigns the area to a descendant of [Object], so it can exist in the node tree. - + Removes all shapes from a body. @@ -326,21 +326,21 @@ - + Returns the physics layer or layers a body belongs to. - + Returns the physics layer or layers a body can collide with. - + Returns the body's total constant positional forces applied during each physics update. See [method body_add_constant_force] and [method body_add_constant_central_force]. @@ -348,7 +348,7 @@ - + Returns the body's total constant rotational forces applied during each physics update. See [method body_add_constant_torque]. @@ -356,103 +356,103 @@ - + Returns the [PhysicsDirectBodyState3D] of the body. Returns [code]null[/code] if the body is destroyed or removed from the physics space. - + Returns the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. - + Returns the body mode. - + Gets the instance ID of the object the area is assigned to. - - + + Returns the value of a body parameter. A list of available parameters is on the [enum BodyParameter] constants. - - + + Returns the [RID] of the nth shape of a body. - + Returns the number of shapes assigned to a body. - - + + Returns the transform matrix of a body shape. - + Returns the [RID] of the space assigned to a body. - - + + Returns a body state. - - + + - + If [code]true[/code], the continuous collision detection mode is enabled. - + Returns whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). - - + + Removes a body from the list of bodies exempt from collisions. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. @@ -460,55 +460,55 @@ - - + + Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. - + Restores the default inertia and center of mass based on shapes to cancel any custom values previously set using [method body_set_param]. - - - + + + - - + + Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. - - + + Sets the physics layer or layers a body belongs to. - - + + Sets the physics layer or layers a body can collide with. - - + + Sets the body's total constant positional forces applied during each physics update. See [method body_add_constant_force] and [method body_add_constant_central_force]. @@ -516,8 +516,8 @@ - - + + Sets the body's total constant rotational forces applied during each physics update. See [method body_add_constant_torque]. @@ -525,8 +525,8 @@ - - + + If [code]true[/code], the continuous collision detection mode is enabled. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. @@ -534,9 +534,9 @@ - - - + + + Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]). The force integration function takes 2 arguments: @@ -546,93 +546,93 @@ - - + + Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. - - + + Sets the body mode, from one of the [enum BodyMode] constants. - - + + Sets whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). - - - + + + Sets a body parameter. A list of available parameters is on the [enum BodyParameter] constants. - - + + Sets the body pickable with rays if [code]enabled[/code] is set. - - - + + + Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID]. - - - + + + - - - + + + Sets the transform matrix for a body shape. - - + + Assigns a space to the body (see [method space_create]). - - - + + + Sets a body state (see [enum BodyState] constants). - - - + + + Returns [code]true[/code] if a collision would result from moving along a motion vector from a given point in space. [PhysicsTestMotionParameters3D] is passed to set motion parameters. [PhysicsTestMotionResult3D] can be passed to return additional information. @@ -654,17 +654,17 @@ - - + + Gets a cone_twist_joint parameter (see [enum ConeTwistJointParam] constants). - - - + + + Sets a cone_twist_joint parameter (see [enum ConeTwistJointParam] constants). @@ -686,52 +686,52 @@ - + Destroys any of the objects created by PhysicsServer3D. If the [RID] passed is not one of the objects that can be created by PhysicsServer3D, an error will be sent to the console. - - - + + + Gets a generic_6_DOF_joint flag (see [enum G6DOFJointAxisFlag] constants). - - - + + + Gets a generic_6_DOF_joint parameter (see [enum G6DOFJointAxisParam] constants). - - - - + + + + Sets a generic_6_DOF_joint flag (see [enum G6DOFJointAxisFlag] constants). - - - - + + + + Sets a generic_6_DOF_joint parameter (see [enum G6DOFJointAxisParam] constants). - + Returns information about the current state of the 3D physics engine. See [enum ProcessInfo] for a list of available states. @@ -743,41 +743,41 @@ - - + + Gets a hinge_joint flag (see [enum HingeJointFlag] constants). - - + + Gets a hinge_joint parameter (see [enum HingeJointParam]). - - - + + + Sets a hinge_joint flag (see [enum HingeJointFlag] constants). - - - + + + Sets a hinge_joint parameter (see [enum HingeJointParam] constants). - + @@ -788,119 +788,119 @@ - + Gets the priority value of the Joint3D. - + Returns the type of the Joint3D. - - - - - + + + + + - - - - - + + + + + - - - - - + + + + + - - - - - + + + + + - - - - - + + + + + - - + + Sets the priority value of the Joint3D. - + Returns position of the joint in the local space of body a of the joint. - + Returns position of the joint in the local space of body b of the joint. - - + + Gets a pin_joint parameter (see [enum PinJointParam] constants). - - + + Sets position of the joint in the local space of body a of the joint. - - + + Sets position of the joint in the local space of body b of the joint. - - - + + + Sets a pin_joint parameter (see [enum PinJointParam] constants). @@ -912,53 +912,53 @@ - + Activates or deactivates the 3D physics engine. - + Returns the shape data. - + Returns the type of shape (see [enum ShapeType] constants). - - + + Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type]. - - + + Gets a slider_joint parameter (see [enum SliderJointParam] constants). - - - + + + Gets a slider_joint parameter (see [enum SliderJointParam] constants). - + @@ -970,39 +970,39 @@ - + Returns the state of a space, a [PhysicsDirectSpaceState3D]. This object can be used to make collision/intersection queries. - - + + Returns the value of a space parameter. - + Returns whether the space is active. - - + + Marks a space as active. It will not have an effect, unless it is assigned to an area or body. - - - + + + Sets the value for a space parameter. A list of available parameters is on the [enum SpaceParameter] constants. diff --git a/doc/classes/PhysicsServer3DExtension.xml b/doc/classes/PhysicsServer3DExtension.xml index 795f5b86dd..4188b04e4a 100644 --- a/doc/classes/PhysicsServer3DExtension.xml +++ b/doc/classes/PhysicsServer3DExtension.xml @@ -9,23 +9,23 @@ - - - - + + + + - - + + - + @@ -36,236 +36,236 @@ - + - - + + - - + + - + - - + + - + - + - - + + - - + + - - + + - - + + - - + + - - + + - - - + + + - - + + - - - + + + - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - - + + + - - + + - - - - + + + + - - + + - - + + - - - + + + - - - + + + - - + + - - + + - - + + - + @@ -276,273 +276,273 @@ - + - + - + - + - + - + - + - + - - + + - - + + - + - - + + - + - - + + - - + + - + - + - - + + - - + + - + - - - + + + - - + + - - + + - - + + - - + + - - + + - - + + - - - + + + - - + + - - + + - - + + - - - + + + - - + + - - - + + + - - - + + + - - - + + + - - + + - - - + + + - - - - - - - + + + + + + + @@ -563,16 +563,16 @@ - - + + - - - + + + @@ -593,47 +593,47 @@ - + - - - + + + - - - + + + - - - - + + + + - - - - + + + + - + @@ -644,37 +644,37 @@ - - + + - - + + - - - + + + - - - + + + - + @@ -685,111 +685,111 @@ - + - + - - - - - + + + + + - - - - - + + + + + - - - - - + + + + + - - - - - + + + + + - - - - - + + + + + - - + + - + - + - - + + - - + + - - + + - - - + + + @@ -800,47 +800,47 @@ - + - + - + - - + + - - + + - - - + + + - + @@ -851,35 +851,35 @@ - + - - + + - + - - + + - - - + + + diff --git a/doc/classes/PhysicsServer3DRenderingServerHandler.xml b/doc/classes/PhysicsServer3DRenderingServerHandler.xml index a40a2dd1c6..90066aeb2c 100644 --- a/doc/classes/PhysicsServer3DRenderingServerHandler.xml +++ b/doc/classes/PhysicsServer3DRenderingServerHandler.xml @@ -9,21 +9,21 @@ - + - - + + - - + + diff --git a/doc/classes/PhysicsTestMotionResult3D.xml b/doc/classes/PhysicsTestMotionResult3D.xml index e347a350c2..f82df1989f 100644 --- a/doc/classes/PhysicsTestMotionResult3D.xml +++ b/doc/classes/PhysicsTestMotionResult3D.xml @@ -11,35 +11,35 @@ - + Returns the colliding body's attached [Object] given a collision index (the deepest collision by default), if a collision occurred. - + Returns the unique instance ID of the colliding body's attached [Object] given a collision index (the deepest collision by default), if a collision occurred. See [method Object.get_instance_id]. - + Returns the colliding body's [RID] used by the [PhysicsServer3D] given a collision index (the deepest collision by default), if a collision occurred. - + Returns the colliding body's shape index given a collision index (the deepest collision by default), if a collision occurred. See [CollisionObject3D]. - + Returns the colliding body's velocity given a collision index (the deepest collision by default), if a collision occurred. @@ -52,28 +52,28 @@ - + Returns the length of overlap along the collision normal given a collision index (the deepest collision by default), if a collision occurred. - + Returns the moving object's colliding shape given a collision index (the deepest collision by default), if a collision occurred. - + Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default), if a collision occurred. - + Returns the point of collision in global coordinates given a collision index (the deepest collision by default), if a collision occurred. diff --git a/doc/classes/PinJoint3D.xml b/doc/classes/PinJoint3D.xml index 013a18b92c..007cdf830d 100644 --- a/doc/classes/PinJoint3D.xml +++ b/doc/classes/PinJoint3D.xml @@ -11,15 +11,15 @@ - + Returns the value of the specified parameter. - - + + Sets the value of the specified parameter. diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index df9d25902b..63a05ef15c 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -18,49 +18,49 @@ - + Constructs a [Plane] as a copy of the given [Plane]. - - - - + + + + Creates a plane from the four parameters. The three components of the resulting plane's [member normal] are [code]a[/code], [code]b[/code] and [code]c[/code], and the plane has a distance of [code]d[/code] from the origin. - + Creates a plane from the normal vector. The plane will intersect the origin. - - + + Creates a plane from the normal vector and the plane's distance from the origin. - - + + Creates a plane from the normal vector and a point on the plane. - - - + + + Creates a plane from the three points, given in clockwise order. @@ -75,53 +75,53 @@ - + Returns the shortest distance from the plane to the position [code]point[/code]. If the point is above the plane, the distance will be positive. If below, the distance will be negative. - - + + Returns [code]true[/code] if [code]point[/code] is inside the plane. Comparison uses a custom minimum [code]tolerance[/code] threshold. - - + + Returns the intersection point of the three planes [code]b[/code], [code]c[/code] and this plane. If no intersection is found, [code]null[/code] is returned. - - + + Returns the intersection point of a ray consisting of the position [code]from[/code] and the direction normal [code]dir[/code] with this plane. If no intersection is found, [code]null[/code] is returned. - - + + Returns the intersection point of a segment from position [code]from[/code] to position [code]to[/code] with this plane. If no intersection is found, [code]null[/code] is returned. - + Returns [code]true[/code] if this plane and [code]plane[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. - + Returns [code]true[/code] if [code]point[/code] is located above the plane. @@ -134,7 +134,7 @@ - + Returns the orthogonal projection of [code]point[/code] into a point in the plane. @@ -173,7 +173,7 @@ - + Returns [code]true[/code] if the planes are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -181,14 +181,14 @@ - + Inversely transforms (multiplies) the [Plane] by the given [Transform3D] transformation matrix. - + Returns [code]true[/code] if the planes are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index 5f75ac6c50..8498e703fb 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -11,8 +11,8 @@ - - + + Adds a bone with the specified [code]path[/code] and [code]weights[/code]. @@ -25,7 +25,7 @@ - + Removes the specified bone from this [Polygon2D]. @@ -38,30 +38,30 @@ - + Returns the path to the node associated with the specified bone. - + Returns the height values of the specified bone. - - + + Sets the path to the node associated with the specified bone. - - + + Sets the weight values for the specified bone. diff --git a/doc/classes/PolygonPathFinder.xml b/doc/classes/PolygonPathFinder.xml index dbe9978ef5..84d757bfca 100644 --- a/doc/classes/PolygonPathFinder.xml +++ b/doc/classes/PolygonPathFinder.xml @@ -9,8 +9,8 @@ - - + + @@ -21,40 +21,40 @@ - + - - + + - + - + - - + + - - + + diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 5da2196f29..410489481e 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -15,9 +15,9 @@ - - - + + + Adds a new checkable item with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -26,9 +26,9 @@ - - - + + + Adds a new checkable item and assigns the specified [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -37,10 +37,10 @@ - - - - + + + + Adds a new checkable item with text [code]label[/code] and icon [code]texture[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -49,10 +49,10 @@ - - - - + + + + Adds a new checkable item and assigns the specified [Shortcut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -61,10 +61,10 @@ - - - - + + + + Adds a new item with text [code]label[/code] and icon [code]texture[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -72,30 +72,30 @@ - - - - + + + + Same as [method add_icon_check_item], but uses a radio check button. - - - - + + + + Same as [method add_icon_check_shortcut], but uses a radio check button. - - - - + + + + Adds a new item and assigns the specified [Shortcut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -103,9 +103,9 @@ - - - + + + Adds a new item with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -114,11 +114,11 @@ - - - - - + + + + + Adds a new multistate item with text [code]label[/code]. Contrarily to normal binary items, multistate items can have more than two states, as defined by [code]max_states[/code]. Each press or activate of the item will increase the state by one. The default value is defined by [code]default_state[/code]. @@ -127,9 +127,9 @@ - - - + + + Adds a new radio check button with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -138,9 +138,9 @@ - - - + + + Adds a new radio check button and assigns a [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -149,8 +149,8 @@ - - + + Adds a separator between items. Separators also occupy an index, which you can set by using the [code]id[/code] parameter. A [code]label[/code] can optionally be provided, which will appear at the center of the separator. @@ -158,9 +158,9 @@ - - - + + + Adds a [Shortcut]. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -168,9 +168,9 @@ - - - + + + Adds an item that will act as a submenu of the parent [PopupMenu] node when clicked. The [code]submenu[/code] argument is the name of the child [PopupMenu] node that will be shown when the item is clicked. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -190,91 +190,91 @@ - + Returns the accelerator of the item at the given [code]index[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. - + Returns the horizontal offset of the item at the given [code]index[/code]. - + Returns the icon of the item at the given [code]index[/code]. - + Returns the id of the item at the given [code]index[/code]. [code]id[/code] can be manually assigned, while index can not. - + Returns the index of the item containing the specified [code]id[/code]. Index is automatically assigned to each item by the engine and can not be set manually. - + Returns item's text language code. - + Returns the metadata of the specified item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items. - + Returns the [Shortcut] associated with the item at the given [code]index[/code]. - + Returns the submenu name of the item at the given [code]index[/code]. See [method add_submenu_item] for more info on how to add a submenu. - + Returns the text of the item at the given [code]index[/code]. - + Returns item's text base writing direction. - + Returns the tooltip associated with the item at the given [code]index[/code]. - + Returns [code]true[/code] if the item at the given [code]index[/code] is checkable in some way, i.e. if it has a checkbox or radio button. [b]Note:[/b] Checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. @@ -282,14 +282,14 @@ - + Returns [code]true[/code] if the item at the given [code]index[/code] is checked. - + Returns [code]true[/code] if the item at the given [code]index[/code] is disabled. When it is disabled it can't be selected, or its action invoked. See [method set_item_disabled] for more info on how to disable an item. @@ -297,7 +297,7 @@ - + Returns [code]true[/code] if the item at the given [code]index[/code] has radio button-style checkability. [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. @@ -305,21 +305,21 @@ - + Returns [code]true[/code] if the item is a separator. If it is, it will be displayed as a line. See [method add_separator] for more info on how to add a separator. - + Returns [code]true[/code] if the specified item's shortcut is disabled. - + Removes the item at the given [code]index[/code] from the menu. [b]Note:[/b] The indices of items after the removed item will be shifted by one. @@ -327,30 +327,30 @@ - + Moves the scroll view to make the item at the given [code]index[/code] visible. - + Sets the currently focused item as the given [code]index[/code]. - - + + Sets the accelerator of the item at the given [code]index[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. - - + + Sets whether the item at the given [code]index[/code] has a checkbox. If [code]false[/code], sets the type of the item to plain text. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. @@ -358,56 +358,56 @@ - - + + Sets the type of the item at the given [code]index[/code] to radio button. If [code]false[/code], sets the type of the item to plain text. - - + + Mark the item at the given [code]index[/code] as a separator, which means that it would be displayed as a line. If [code]false[/code], sets the type of the item to plain text. - - + + Sets the checkstate status of the item at the given [code]index[/code]. - - + + Enables/disables the item at the given [code]index[/code]. When it is disabled, it can't be selected and its action can't be invoked. - - + + Sets the horizontal offset of the item at the given [code]index[/code]. - - + + Replaces the [Texture2D] icon of the item at the given [code]index[/code]. - - + + Sets the [code]id[/code] of the item at the given [code]index[/code]. The [code]id[/code] is used in [signal id_pressed] and [signal id_focused] signals. @@ -415,87 +415,87 @@ - - + + Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. - - + + Sets the metadata of an item, which may be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items. - - + + Sets the state of a multistate item. See [method add_multistate_item] for details. - - - + + + Sets a [Shortcut] for the item at the given [code]index[/code]. - - + + Disables the [Shortcut] of the item at the given [code]index[/code]. - - + + Sets the submenu of the item at the given [code]index[/code]. The submenu is the name of a child [PopupMenu] node that would be shown when the item is clicked. - - + + Sets the text of the item at the given [code]index[/code]. - - + + Sets item's text base writing direction. - - + + Sets the [String] tooltip of the item at the given [code]index[/code]. - + Toggles the check state of the item at the given [code]index[/code]. - + Cycle to the next state of a multistate item. See [method add_multistate_item] for details. @@ -523,19 +523,19 @@ - + Emitted when user navigated to an item of some [code]id[/code] using [code]ui_up[/code] or [code]ui_down[/code] action. - + Emitted when an item of some [code]id[/code] is pressed or its accelerator is activated. - + Emitted when an item of some [code]index[/code] is pressed or its accelerator is activated. diff --git a/doc/classes/PortableCompressedTexture2D.xml b/doc/classes/PortableCompressedTexture2D.xml index aad72bbb48..c7e2f2fbdc 100644 --- a/doc/classes/PortableCompressedTexture2D.xml +++ b/doc/classes/PortableCompressedTexture2D.xml @@ -15,10 +15,10 @@ - - - - + + + + Initializes the compressed texture from a base image. The compression mode must be provided. If this image will be used as a normal map, the "normal map" flag is recommended, to ensure optimum quality. @@ -45,7 +45,7 @@ - + Overrides the flag globally for all textures of this type. This is used primarily by the editor. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 9df8d2df80..a6c18bbe2f 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -17,7 +17,7 @@ - + Adds a custom property info to a property. The dictionary must contain: - [code]name[/code]: [String] (the property's name) @@ -55,21 +55,21 @@ - + Clears the whole configuration (not recommended, may break things). - + Returns the order of a configuration value (influences when saved to the config file). - + Returns the value of a setting. [b]Example:[/b] @@ -85,7 +85,7 @@ - + Returns the absolute, native OS path corresponding to the localized [code]path[/code] (starting with [code]res://[/code] or [code]user://[/code]). The returned path will vary depending on the operating system and user preferences. See [url=$DOCS_URL/tutorials/io/data_paths.html]File paths in Godot projects[/url] to see what those paths convert to. See also [method localize_path]. [b]Note:[/b] [method globalize_path] with [code]res://[/code] will not work in an exported project. Instead, prepend the executable's base directory to the path when running from an exported project: @@ -106,16 +106,16 @@ - + Returns [code]true[/code] if a configuration value is present. - - - + + + Loads the contents of the .pck or .zip file specified by [code]pack[/code] into the resource filesystem ([code]res://[/code]). Returns [code]true[/code] on success. [b]Note:[/b] If a file from [code]pack[/code] shares the same path as a file already in the resource filesystem, any attempts to load that file will use the file from [code]pack[/code] unless [code]replace_files[/code] is set to [code]false[/code]. @@ -124,21 +124,21 @@ - + Returns the localized path (starting with [code]res://[/code]) corresponding to the absolute, native OS [code]path[/code]. See also [method globalize_path]. - + Returns [code]true[/code] if the specified property exists and its initial value differs from the current value. - + Returns the specified property's initial value. Returns [code]null[/code] if the property does not exist. @@ -152,31 +152,31 @@ - + Saves the configuration to a custom file. The file extension must be [code].godot[/code] (to save in text-based [ConfigFile] format) or [code].binary[/code] (to save in binary format). You can also save [code]override.cfg[/code] file, which is also text, but can be used in exported projects unlike other formats. - - + + Sets the specified property's initial value. This is the value the property reverts to. - - + + Sets the order of a configuration value (influences when saved to the config file). - - + + Sets the value of a setting. [b]Example:[/b] diff --git a/doc/classes/Projection.xml b/doc/classes/Projection.xml index 2bbfd04e9e..b8f6e54d87 100644 --- a/doc/classes/Projection.xml +++ b/doc/classes/Projection.xml @@ -14,13 +14,13 @@ - + - + @@ -28,98 +28,98 @@ - + - + - - - - - - - - + + + + + + + + - - - - - - + + + + + + - - - - - - + + + + + + - + - - - - - - + + + + + + - - - - - + + + + + - - - - - + + + + + - - - - - - - - + + + + + + + + @@ -150,8 +150,8 @@ - - + + @@ -162,13 +162,13 @@ - + - + @@ -199,13 +199,13 @@ - + - + @@ -241,31 +241,31 @@ - + - + - + - + - + diff --git a/doc/classes/PropertyTweener.xml b/doc/classes/PropertyTweener.xml index e0fbeec7c1..75d9c919aa 100644 --- a/doc/classes/PropertyTweener.xml +++ b/doc/classes/PropertyTweener.xml @@ -22,7 +22,7 @@ - + Sets a custom initial value to the [PropertyTweener]. Example: [codeblock] @@ -43,21 +43,21 @@ - + Sets the time in seconds after which the [PropertyTweener] will start interpolating. By default there's no delay. - + Sets the type of used easing from [enum Tween.EaseType]. If not set, the default easing is used from the [Tween] that contains this Tweener. - + Sets the type of used transition from [enum Tween.TransitionType]. If not set, the default transition is used from the [Tween] that contains this Tweener. diff --git a/doc/classes/Quaternion.xml b/doc/classes/Quaternion.xml index 30e96607da..e75d4ea737 100644 --- a/doc/classes/Quaternion.xml +++ b/doc/classes/Quaternion.xml @@ -21,45 +21,45 @@ - + Constructs a [Quaternion] as a copy of the given [Quaternion]. - - + + - - + + Constructs a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. - + - + Constructs a quaternion from the given [Basis]. - - - - + + + + Constructs a quaternion defined by the given values. @@ -68,7 +68,7 @@ - + Returns the angle between this quaternion and [code]to[/code]. This is the magnitude of the angle you would need to rotate by to get from one to the other. [b]Note:[/b] This method has an abnormally high amount of floating-point error, so methods such as [code]is_zero_approx[/code] will not work reliably. @@ -76,7 +76,7 @@ - + Returns the dot product of two quaternions. @@ -110,7 +110,7 @@ - + Returns [code]true[/code] if this quaternion and [code]quat[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. @@ -146,8 +146,8 @@ - - + + Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code]. [b]Note:[/b] Both quaternions must be normalized. @@ -155,18 +155,18 @@ - - + + Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code], but without checking if the rotation path is not bigger than 90 degrees. - - - - + + + + Performs a spherical cubic interpolation between quaternions [code]pre_a[/code], this vector, [code]b[/code], and [code]post_b[/code], by the given amount [code]weight[/code]. @@ -198,7 +198,7 @@ - + Returns [code]true[/code] if the quaternions are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -206,63 +206,63 @@ - + Composes these two quaternions by multiplying them together. This has the effect of rotating the second quaternion (the child) by the first quaternion (the parent). - + Rotates (multiplies) the [Vector3] by the given [Quaternion]. - + Multiplies each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. - + Multiplies each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. - + Adds each component of the left [Quaternion] to the right [Quaternion]. This operation is not meaningful on its own, but it can be used as a part of a larger expression, such as approximating an intermediate rotation between two nearby rotations. - + Subtracts each component of the left [Quaternion] by the right [Quaternion]. This operation is not meaningful on its own, but it can be used as a part of a larger expression. - + Divides each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. - + Divides each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. - + Returns [code]true[/code] if the quaternions are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -270,7 +270,7 @@ - + Access quaternion components using their index. [code]q[0][/code] is equivalent to [code]q.x[/code], [code]q[1][/code] is equivalent to [code]q.y[/code], [code]q[2][/code] is equivalent to [code]q.z[/code], and [code]q[3][/code] is equivalent to [code]q.w[/code]. diff --git a/doc/classes/RDShaderFile.xml b/doc/classes/RDShaderFile.xml index e719337f22..72bf6faaec 100644 --- a/doc/classes/RDShaderFile.xml +++ b/doc/classes/RDShaderFile.xml @@ -9,7 +9,7 @@ - + @@ -20,8 +20,8 @@ - - + + diff --git a/doc/classes/RDShaderSPIRV.xml b/doc/classes/RDShaderSPIRV.xml index 4453d7eb27..13dc2c6519 100644 --- a/doc/classes/RDShaderSPIRV.xml +++ b/doc/classes/RDShaderSPIRV.xml @@ -9,27 +9,27 @@ - + - + - - + + - - + + diff --git a/doc/classes/RDShaderSource.xml b/doc/classes/RDShaderSource.xml index 4c3c21bcb9..ddeae95e39 100644 --- a/doc/classes/RDShaderSource.xml +++ b/doc/classes/RDShaderSource.xml @@ -9,14 +9,14 @@ - + - - + + diff --git a/doc/classes/RDTextureFormat.xml b/doc/classes/RDTextureFormat.xml index fe2f6d7b1c..1b70303d2d 100644 --- a/doc/classes/RDTextureFormat.xml +++ b/doc/classes/RDTextureFormat.xml @@ -9,13 +9,13 @@ - + - + diff --git a/doc/classes/RDUniform.xml b/doc/classes/RDUniform.xml index 29664d7c40..d144024000 100644 --- a/doc/classes/RDUniform.xml +++ b/doc/classes/RDUniform.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml index 39be605e1b..a6523e4c8b 100644 --- a/doc/classes/RID.xml +++ b/doc/classes/RID.xml @@ -17,7 +17,7 @@ - + Constructs a [RID] as a copy of the given [RID]. @@ -40,37 +40,37 @@ - + - + - + - + - + - + diff --git a/doc/classes/RandomNumberGenerator.xml b/doc/classes/RandomNumberGenerator.xml index 28151e858e..726f9e91d8 100644 --- a/doc/classes/RandomNumberGenerator.xml +++ b/doc/classes/RandomNumberGenerator.xml @@ -27,16 +27,16 @@ - - + + Returns a pseudo-random float between [code]from[/code] and [code]to[/code] (inclusive). - - + + Returns a [url=https://en.wikipedia.org/wiki/Normal_distribution]normally-distributed[/url] pseudo-random number, using Box-Muller transform with the specified [code]mean[/code] and a standard [code]deviation[/code]. This is also called Gaussian distribution. @@ -49,8 +49,8 @@ - - + + Returns a pseudo-random 32-bit signed integer between [code]from[/code] and [code]to[/code] (inclusive). diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index 22793e75d8..a4be738395 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -11,14 +11,14 @@ - + Called when the [Range]'s value is changed (following the same conditions as [signal value_changed]). - + Binds two [Range]s together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group. @@ -69,7 +69,7 @@ - + Emitted when [member value] changes. When used on a [Slider], this is called continuously while dragging (potentially every frame). If you are performing an expensive operation in a function connected to [signal value_changed], consider using a [i]debouncing[/i] [Timer] to call the function less often. [b]Note:[/b] Unlike signals such as [signal LineEdit.text_changed], [signal value_changed] is also emitted when [code]value[/code] is set directly via code. diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 2a7d3502df..bbf29c1f44 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -16,14 +16,14 @@ - + Adds a collision exception so the ray does not report collisions with the specified [CollisionObject2D] node. - + Adds a collision exception so the ray does not report collisions with the specified [RID]. @@ -55,7 +55,7 @@ - + Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. @@ -81,22 +81,22 @@ - + Removes a collision exception so the ray does report collisions with the specified [CollisionObject2D] node. - + Removes a collision exception so the ray does report collisions with the specified [RID]. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. diff --git a/doc/classes/RayCast3D.xml b/doc/classes/RayCast3D.xml index 65437daa79..09ce79191d 100644 --- a/doc/classes/RayCast3D.xml +++ b/doc/classes/RayCast3D.xml @@ -17,14 +17,14 @@ - + Adds a collision exception so the ray does not report collisions with the specified [CollisionObject3D] node. - + Adds a collision exception so the ray does not report collisions with the specified [RID]. @@ -56,7 +56,7 @@ - + Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. @@ -82,22 +82,22 @@ - + Removes a collision exception so the ray does report collisions with the specified [CollisionObject3D] node. - + Removes a collision exception so the ray does report collisions with the specified [RID]. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index e4b66a9d53..082075b161 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -23,32 +23,32 @@ - + Constructs a [Rect2] as a copy of the given [Rect2]. - + Constructs a [Rect2] from a [Rect2i]. - - + + Constructs a [Rect2] by position and size. - - - - + + + + Constructs a [Rect2] by x, y, width, and height. @@ -63,14 +63,14 @@ - + Returns [code]true[/code] if this [Rect2] completely encloses another one. - + Returns a copy of this [Rect2] expanded to include a given point. [b]Example:[/b] @@ -104,25 +104,25 @@ - + Returns a copy of the [Rect2] grown by the specified [code]amount[/code] on all sides. - - - - + + + + Returns a copy of the [Rect2] grown by the specified amount on each side individually. - - + + Returns a copy of the [Rect2] grown by the specified [code]amount[/code] on the specified [enum Side]. @@ -136,7 +136,7 @@ - + Returns [code]true[/code] if the [Rect2] contains a point. By convention, the right and bottom edges of the [Rect2] are considered exclusive, so points on these edges are [b]not[/b] included. [b]Note:[/b] This method is not reliable for [Rect2] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent rectangle to check for contained points. @@ -144,7 +144,7 @@ - + Returns the intersection of this [Rect2] and [code]b[/code]. If the rectangles do not intersect, an empty [Rect2] is returned. @@ -152,8 +152,8 @@ - - + + Returns [code]true[/code] if the [Rect2] overlaps with [code]b[/code] (i.e. they have at least one point in common). If [code]include_borders[/code] is [code]true[/code], they will also be considered overlapping if their borders touch, even without intersection. @@ -161,14 +161,14 @@ - + Returns [code]true[/code] if this [Rect2] and [code]rect[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. - + Returns a larger [Rect2] that contains this [Rect2] and [code]b[/code]. @@ -189,7 +189,7 @@ - + Returns [code]true[/code] if the rectangles are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -197,14 +197,14 @@ - + Inversely transforms (multiplies) the [Rect2] by the given [Transform2D] transformation matrix. - + Returns [code]true[/code] if the rectangles are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml index c9ae685a15..a71380c69a 100644 --- a/doc/classes/Rect2i.xml +++ b/doc/classes/Rect2i.xml @@ -21,32 +21,32 @@ - + Constructs a [Rect2i] as a copy of the given [Rect2i]. - + Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated. - - + + Constructs a [Rect2i] by position and size. - - - - + + + + Constructs a [Rect2i] by x, y, width, and height. @@ -61,14 +61,14 @@ - + Returns [code]true[/code] if this [Rect2i] completely encloses another one. - + Returns a copy of this [Rect2i] expanded so that the borders align with the given point. [codeblocks] @@ -102,25 +102,25 @@ - + Returns a copy of the [Rect2i] grown by the specified [code]amount[/code] on all sides. - - - - + + + + Returns a copy of the [Rect2i] grown by the specified amount on each side individually. - - + + Returns a copy of the [Rect2i] grown by the specified [code]amount[/code] on the specified [enum Side]. @@ -134,7 +134,7 @@ - + Returns [code]true[/code] if the [Rect2i] contains a point. By convention, the right and bottom edges of the [Rect2i] are considered exclusive, so points on these edges are [b]not[/b] included. [b]Note:[/b] This method is not reliable for [Rect2i] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent rectangle to check for contained points. @@ -142,7 +142,7 @@ - + Returns the intersection of this [Rect2i] and [code]b[/code]. If the rectangles do not intersect, an empty [Rect2i] is returned. @@ -150,14 +150,14 @@ - + Returns [code]true[/code] if the [Rect2i] overlaps with [code]b[/code] (i.e. they have at least one point in common). - + Returns a larger [Rect2i] that contains this [Rect2i] and [code]b[/code]. @@ -178,14 +178,14 @@ - + Returns [code]true[/code] if the rectangles are not equal. - + Returns [code]true[/code] if the rectangles are equal. diff --git a/doc/classes/RenderingDevice.xml b/doc/classes/RenderingDevice.xml index 3962f309de..2f0b9dae72 100644 --- a/doc/classes/RenderingDevice.xml +++ b/doc/classes/RenderingDevice.xml @@ -9,102 +9,102 @@ - - + + - - - - + + + + - + - - - - - + + + + + - + - + - + - - + + - - - + + + - - - - + + + + - + - - - + + + - - + + - + @@ -115,8 +115,8 @@ - - + + @@ -127,111 +127,111 @@ - - + + - - - - - - - - - - + + + + + + + + + + - - + + - - - - - - - - - - - + + + + + + + + + + + - - + + - - + + - - - + + + - - + + - + - - - - + + + + - - + + - + - - - + + + @@ -242,78 +242,78 @@ - + - - - + + + - - - + + + - - - - + + + + - - + + - + - - - + + + - - + + - + - + - + @@ -324,19 +324,19 @@ - + - + - + @@ -367,9 +367,9 @@ - - - + + + @@ -380,58 +380,58 @@ - + - - - + + + - - - - + + + + - + - - - - - - - - - - - + + + + + + + + + + + - + - + @@ -442,61 +442,61 @@ - + - + - - + + - - + + - - + + - + - - + + - + - - - + + + @@ -512,140 +512,140 @@ - - - + + + - - - - - - - + + + + + + + - - - - - - - - - - + + + + + + + + + + - - - + + + - - + + - - - - - - + + + + + + - - + + - - + + - + - + - - - + + + - - - - + + + + - - + + - - - + + + - + - - - + + + - + diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index c06b2e1d98..19a75c8515 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -20,9 +20,9 @@ - - - + + + @@ -40,104 +40,104 @@ - - - + + + - - - - - - - - + + + + + + + + - + - - + + - - + + - - + + Sets the cull mask associated with this camera. The cull mask describes which 3D layers are rendered by this camera. Equivalent to [member Camera3D.cull_mask]. - - + + Sets the environment used by this camera. Equivalent to [member Camera3D.environment]. - - - - - + + + + + Sets camera to use frustum projection. This mode allows adjusting the [code]offset[/code] argument to create "tilted frustum" effects. - - - - + + + + Sets camera to use orthogonal projection, also known as orthographic projection. Objects remain the same size on the screen no matter how far away they are. - - - - + + + + Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away. - - + + Sets [Transform3D] of camera. - - + + If [code]true[/code], preserves the horizontal aspect ratio which is equivalent to [constant Camera3D.KEEP_WIDTH]. If [code]false[/code], preserves the vertical aspect ratio which is equivalent to [constant Camera3D.KEEP_HEIGHT]. @@ -151,181 +151,181 @@ - - - - - + + + + + Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly. - - - - + + + + - - + + - - - - - - + + + + + + - - - - - + + + + + - - - - - - - + + + + + + + - - - + + + - - - - - - - - - - + + + + + + + + + + - - - + + + - - - - - + + + + + - - - - - + + + + + - - - - - - + + + + + + - - - + + + - - + + - - - - - - + + + + + + - - - - - - - + + + + + + + - - - - - - - - - + + + + + + + + + - + Clears the [CanvasItem] and removes all commands in it. @@ -337,170 +337,170 @@ - - - - - - + + + + + + - - + + - - - + + + Sets the [CanvasItem] to copy a rect to the backbuffer. - - - + + + - - + + - - + + - - + + - - + + - - + + Sets the index for the [CanvasItem]. - - + + - - + + Sets a new material to the [CanvasItem]. - - + + - - + + - - + + - - + + - - + + - - + + Sets if the [CanvasItem] uses its parent's material. - - - - - + + + + + - - + + - - + + If this is enabled, the Z index of the parent will be added to the children's Z index. - - + + Sets the [CanvasItem]'s Z index, i.e. its draw order (lower indexes are drawn first). - - + + Attaches the canvas light to the canvas. Removes it from its previous canvas. @@ -514,8 +514,8 @@ - - + + Attaches a light occluder to the canvas. Removes it from its previous canvas. @@ -529,177 +529,177 @@ - - + + - - + + Enables or disables light occluder. - - + + The light mask. See [LightOccluder2D] for more information on light masks. - - + + Sets a light occluder's polygon. - - + + Sets a light occluder's [Transform2D]. - - + + Sets the color for a light. - - + + Enables or disables a canvas light. - - + + Sets a canvas light's energy. - - + + Sets a canvas light's height. - - + + The light mask. See [LightOccluder2D] for more information on light masks. - - + + The binary mask used to determine which layers this canvas light's shadows affects. See [LightOccluder2D] for more information on light masks. - - - + + + The layer range that gets rendered with this light. - - + + The mode of the light, see [enum CanvasLightMode] constants. - - + + Sets the color of the canvas light's shadow. - - + + Enables or disables the canvas light's shadow. - - + + Sets the canvas light's shadow's filter, see [enum CanvasLightShadowFilter] constants. - - + + Smoothens the shadow. The lower, the smoother. - - + + Sets the texture to be used by a [PointLight2D]. Equivalent to [member PointLight2D.texture]. - - + + Sets the offset of a [PointLight2D]'s texture. Equivalent to [member PointLight2D.offset]. - - + + Sets the scale factor of a [PointLight2D]'s texture. Equivalent to [member PointLight2D.texture_scale]. - - + + Sets the canvas light's [Transform2D]. - - - + + + Sets the Z range of objects that will be affected by this light. Equivalent to [member Light2D.range_z_min] and [member Light2D.range_z_max]. @@ -713,47 +713,47 @@ - - + + Sets an occluder polygons cull mode. See [enum CanvasOccluderPolygonCullMode] constants. - - - + + + Sets the shape of the occluder polygon. - + - - - + + + A copy of the canvas item will be drawn with a local offset of the mirroring [Vector2]. - - + + Modulates all colors in the given canvas. - + @@ -764,31 +764,31 @@ - - - + + + - - - + + + - - + + - - + + @@ -804,74 +804,74 @@ - - + + - - + + - - - - + + + + - - + + - - + + - - - + + + - - + + - - + + - - - + + + - + @@ -885,22 +885,22 @@ - - + + - + - - - + + + @@ -913,264 +913,264 @@ - + - + - - - - - - - + + + + + + + Sets the values to be used with the "Adjustment" post-process effect. See [Environment] for more details. - - - - - - + + + + + + - - + + Sets the [i]BGMode[/i] of the environment. Equivalent to [member Environment.background_mode]. - - + + Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). - - + + Sets the intensity of the background color. - - + + Sets the maximum layer to use if using Canvas background mode. - - - - - - - - - + + + + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - + + + + + + + + + + + - + - + - + - - + + Sets the [Sky] to be used as the environment's background when using [i]BGMode[/i] sky. Equivalent to [member Environment.sky]. - - + + Sets a custom field of view for the background [Sky]. Equivalent to [member Environment.sky_custom_fov]. - - + + Sets the rotation of the background [Sky] expressed as a [Basis]. Equivalent to [member Environment.sky_rotation], where the rotation vector is used to construct the [Basis]. - - - - - - - - - - + + + + + + + + + + Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See [Environment] for more details. - - - - - - + + + + + + Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See [Environment] for more details. - - - - - - + + + + + + Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See [Environment] for more details. - - - - - - + + + + + + Sets the variables to be used with the "screen space reflections" post-process effect. See [Environment] for more details. - + - - - - - - - - - + + + + + + + + + Sets the variables to be used with the "tonemap" post-process effect. See [Environment] for more details. - - - - - - - - - - - - - + + + + + + + + + + + + + - + Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts. - - + + Sets the resolution of the volumetric fog's froxel buffer. [code]size[/code] is modified by the screen's aspect ratio and then used to set the width and height of the buffer. While [code]depth[/code] is directly used to set the depth of the buffer. @@ -1183,32 +1183,32 @@ - - + + Sets the size of the fog volume when shape is [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_CONE], [constant RenderingServer.FOG_VOLUME_SHAPE_CYLINDER] or [constant RenderingServer.FOG_VOLUME_SHAPE_BOX]. - - + + Sets the [Material] of the fog volume. Can be either a [FogMaterial] or a custom [ShaderMaterial]. - - + + Sets the shape of the fog volume to either [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_CONE], [constant RenderingServer.FOG_VOLUME_SHAPE_CYLINDER], [constant RenderingServer.FOG_VOLUME_SHAPE_BOX] or [constant RenderingServer.FOG_VOLUME_SHAPE_WORLD]. - - + + @@ -1219,7 +1219,7 @@ - + Tries to free an object in the RenderingServer. @@ -1236,7 +1236,7 @@ - + @@ -1288,22 +1288,22 @@ - + If [code]half_resolution[/code] is [code]true[/code], renders [VoxelGI] and SDFGI ([member Environment.sdfgi_enabled]) buffers at halved resolution (e.g. 960×540 when the viewport size is 1920×1080). This improves performance significantly when VoxelGI or SDFGI is enabled, at the cost of artifacts that may be visible on polygon edges. The loss in quality becomes less noticeable as the viewport resolution increases. [LightmapGI] rendering is not affected by this setting. See also [member ProjectSettings.rendering/global_illumination/gi/use_half_resolution]. - - - + + + - + @@ -1314,27 +1314,27 @@ - + - + - - + + - - + + @@ -1346,30 +1346,30 @@ - + Not yet implemented. Always returns [code]false[/code]. - + Returns [code]true[/code] if the OS supports a certain feature. Features might be [code]s3tc[/code], [code]etc[/code], and [code]etc2[/code]. - - + + Attaches a unique Object ID to instance. Object ID must be attached to instance for proper culling with [method instances_cull_aabb], [method instances_cull_convex], and [method instances_cull_ray]. - - + + Attaches a skeleton to an instance. Removes the previous skeleton from the instance. @@ -1384,8 +1384,8 @@ - - + + Creates a visual instance, adds it to the RenderingServer, and sets both base and scenario. It can be accessed with the RID that is returned. This RID will be used in all [code]instance_*[/code] RenderingServer functions. Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. @@ -1393,85 +1393,85 @@ - - + + - - + + - + - - + + Sets the shadow casting setting to one of [enum ShadowCastingSetting]. Equivalent to [member GeometryInstance3D.cast_shadow]. - - - + + + Sets the flag for a given [enum InstanceFlags]. See [enum InstanceFlags] for more details. - - - - + + + + - - + + - - + + Sets a material that will be rendered for all surfaces on top of active materials for the mesh associated with this instance. Equivalent to [member GeometryInstance3D.material_overlay]. - - + + Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to [member GeometryInstance3D.material_override]. - - - + + + - - + + Sets the transparency for the given geometry instance. Equivalent to [member GeometryInstance3D.transparency]. A transparency of [code]0.0[/code] is fully opaque, while [code]1.0[/code] is fully transparent. Values greater than [code]0.0[/code] (exclusive) will force the geometry's materials to go through the transparent pipeline, which is slower to render and can exhibit rendering issues due to incorrect transparency sorting. However, unlike using a transparent material, setting [code]transparency[/code] to a value greater than [code]0.0[/code] (exclusive) will [i]not[/i] disable shadow rendering. @@ -1481,109 +1481,109 @@ - - - - - - + + + + + + Sets the visibility range values for the given geometry instance. Equivalent to [member GeometryInstance3D.visibility_range_begin] and related properties. - - + + Sets the base of the instance. A base can be any of the 3D objects that are created in the RenderingServer that can be displayed. For example, any of the light types, mesh, multimesh, immediate geometry, particle system, reflection probe, lightmap, and the GI probe are all types that can be set as the base of an instance in order to be displayed in the scenario. - - - + + + Sets the weight for a given blend shape associated with this instance. - - + + Sets a custom AABB to use when culling objects from the view frustum. Equivalent to [method GeometryInstance3D.set_custom_aabb]. - - + + Sets a margin to increase the size of the AABB when culling objects from the view frustum. This allows you to avoid culling objects that fall outside the view frustum. Equivalent to [member GeometryInstance3D.extra_cull_margin]. - - + + - - + + Sets the render layers that this instance will be drawn to. Equivalent to [member VisualInstance3D.layers]. - - + + Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in. - - - + + + Sets the override material of a specific surface. Equivalent to [method MeshInstance3D.set_surface_override_material]. - - + + Sets the world space transform of the instance. Equivalent to [member Node3D.transform]. - - + + Sets the visibility parent for the given instance. Equivalent to [member Node3D.visibility_parent]. - - + + Sets whether an instance is drawn or not. Equivalent to [member Node3D.visible]. - - + + Returns an array of object IDs intersecting with the provided AABB. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GlobalScope.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update. [b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision. @@ -1591,8 +1591,8 @@ - - + + Returns an array of object IDs intersecting with the provided convex shape. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GlobalScope.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update. [b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision. @@ -1600,9 +1600,9 @@ - - - + + + Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GlobalScope.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update. [b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision. @@ -1610,120 +1610,120 @@ - - + + If [code]true[/code], this directional light will blend between shadow map splits resulting in a smoother transition between them. Equivalent to [member DirectionalLight3D.directional_shadow_blend_splits]. - - + + Sets the shadow mode for this directional light. Equivalent to [member DirectionalLight3D.directional_shadow_mode]. See [enum LightDirectionalShadowMode] for options. - - + + If [code]true[/code], this light will not be used for anything except sky shaders. Use this for lights that impact your sky shader that you may want to hide from affecting the rest of the scene. For example, you may want to enable this when the sun in your sky shader falls below the horizon. - - + + Sets whether to use a dual paraboloid or a cubemap for the shadow map. Dual paraboloid is faster but may suffer from artifacts. Equivalent to [member OmniLight3D.omni_shadow_mode]. - + - - + + - - + + Sets the color of the light. Equivalent to [member Light3D.light_color]. - - + + Sets the cull mask for this Light3D. Lights only affect objects in the selected layers. Equivalent to [member Light3D.light_cull_mask]. - - - - - + + + + + Sets the distance fade for this Light3D. This acts as a form of level of detail (LOD) and can be used to improve performance. Equivalent to [member Light3D.distance_fade_enabled], [member Light3D.distance_fade_begin], [member Light3D.distance_fade_shadow], and [member Light3D.distance_fade_length]. - - + + - - + + If [code]true[/code], light will subtract light instead of adding light. Equivalent to [member Light3D.light_negative]. - - - + + + Sets the specified light parameter. See [enum LightParam] for options. Equivalent to [method Light3D.set_param]. - - + + Not implemented in Godot 3.x. - - + + If [code]true[/code], reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double-sided shadows with [method instance_geometry_set_cast_shadows_setting]. Equivalent to [member Light3D.shadow_reverse_cull_face]. - - + + If [code]true[/code], light will cast shadows. Equivalent to [member Light3D.shadow_enabled]. @@ -1735,71 +1735,71 @@ - + - + - + - + - - + + - - - - - + + + + + - + - - + + - - - + + + - - - + + + Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions. @@ -1813,66 +1813,66 @@ - - + + Returns the value of a certain material's parameter. - - + + Sets an object's next material. - - - + + + Sets a material's parameter. - - + + Sets a material's render priority. - - + + Sets a shader material's shader. - - + + - - - - - - + + + + + + - + Removes all surfaces from a mesh. @@ -1887,165 +1887,165 @@ - - + + - + Returns a mesh's blend shape count. - + Returns a mesh's blend shape mode. - + Returns a mesh's custom aabb. - - + + - + Returns a mesh's number of surfaces. - - + + Sets a mesh's blend shape mode. - - + + Sets a mesh's custom aabb. - - + + - - + + Returns a mesh's surface's buffer arrays. - - + + Returns a mesh's surface's arrays for blend shapes. - - + + - - - + + + - - + + - - + + - - + + Returns a mesh's surface's material. - - - + + + Sets a mesh's surface's material. - - - - + + + + - - - - + + + + - - - - + + + + - - - - - + + + + + @@ -2059,125 +2059,125 @@ - + Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh. - + - + Returns the number of instances allocated for this multimesh. - + Returns the RID of the mesh that will be used in drawing this multimesh. - + Returns the number of visible instances for this multimesh. - - + + Returns the color by which the specified instance will be modulated. - - + + Returns the custom data associated with the specified instance. - - + + Returns the [Transform3D] of the specified instance. - - + + Returns the [Transform2D] of the specified instance. For use when the multimesh is set to use 2D transforms. - - - + + + Sets the color by which this instance will be modulated. Equivalent to [method MultiMesh.set_instance_color]. - - - + + + Sets the custom data for this instance. Custom data is passed as a [Color], but is interpreted as a [code]vec4[/code] in the shader. Equivalent to [method MultiMesh.set_instance_custom_data]. - - - + + + Sets the [Transform3D] for this instance. Equivalent to [method MultiMesh.set_instance_transform]. - - - + + + Sets the [Transform2D] for this instance. For use when multimesh is used in 2D. Equivalent to [method MultiMesh.set_instance_transform_2d]. - - + + - - + + Sets the mesh to be drawn by the multimesh. Equivalent to [member MultiMesh.mesh]. - - + + Sets the number of instances visible at a given time. If -1, all instances that have been allocated are drawn. Equivalent to [member MultiMesh.visible_instance_count]. @@ -2189,9 +2189,9 @@ - - - + + + @@ -2210,70 +2210,70 @@ - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + @@ -2287,180 +2287,180 @@ - - - - - - + + + + + + - + Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to [method GPUParticles3D.capture_aabb]. - + Returns [code]true[/code] if particles are currently set to emitting. - + Returns [code]true[/code] if particles are not emitting and particles are set to inactive. - + Add particle system to list of particle systems that need to be updated. Update will take place on the next frame, or on the next call to [method instances_cull_aabb], [method instances_cull_convex], or [method instances_cull_ray]. - + Reset the particles on the next update. Equivalent to [method GPUParticles3D.restart]. - - + + Sets the number of particles to be drawn and allocates the memory for them. Equivalent to [member GPUParticles3D.amount]. - - + + - - + + Sets a custom axis-aligned bounding box for the particle system. Equivalent to [member GPUParticles3D.visibility_aabb]. - - + + Sets the draw order of the particles to one of the named enums from [enum ParticlesDrawOrder]. See [enum ParticlesDrawOrder] for options. Equivalent to [member GPUParticles3D.draw_order]. - - - + + + Sets the mesh to be used for the specified draw pass. Equivalent to [member GPUParticles3D.draw_pass_1], [member GPUParticles3D.draw_pass_2], [member GPUParticles3D.draw_pass_3], and [member GPUParticles3D.draw_pass_4]. - - + + Sets the number of draw passes to use. Equivalent to [member GPUParticles3D.draw_passes]. - - + + Sets the [Transform3D] that will be used by the particles when they first emit. - - + + If [code]true[/code], particles will emit over time. Setting to false does not reset the particles, but only stops their emission. Equivalent to [member GPUParticles3D.emitting]. - - + + Sets the explosiveness ratio. Equivalent to [member GPUParticles3D.explosiveness]. - - + + Sets the frame rate that the particle system rendering will be fixed to. Equivalent to [member GPUParticles3D.fixed_fps]. - - + + If [code]true[/code], uses fractional delta which smooths the movement of the particles. Equivalent to [member GPUParticles3D.fract_delta]. - - + + - - + + Sets the lifetime of each particle in the system. Equivalent to [member GPUParticles3D.lifetime]. - - + + - - + + If [code]true[/code], particles will emit once and then stop. Equivalent to [member GPUParticles3D.one_shot]. - - + + Sets the preprocess time for the particles' animation. This lets you delay starting an animation until after the particles have begun emitting. Equivalent to [member GPUParticles3D.preprocess]. - - + + Sets the material for processing the particles. [b]Note:[/b] This is not the material used to draw the materials. Equivalent to [member GPUParticles3D.process_material]. @@ -2468,60 +2468,60 @@ - - + + Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to [member GPUParticles3D.randomness]. - - + + Sets the speed scale of the particle system. Equivalent to [member GPUParticles3D.speed_scale]. - - + + - - + + - - - + + + - - + + - - + + If [code]true[/code], particles use local coordinates. If [code]false[/code] they use global coordinates. Equivalent to [member GPUParticles3D.local_coords]. - + @@ -2535,114 +2535,114 @@ - - + + - - + + - - + + - - + + If [code]true[/code], reflections will ignore sky contribution. Equivalent to [member ReflectionProbe.interior]. - - + + Sets the render cull mask for this reflection probe. Only instances with a matching cull mask will be rendered by this probe. Equivalent to [member ReflectionProbe.cull_mask]. - - + + If [code]true[/code], uses box projection. This can make reflections look more correct in certain situations. Equivalent to [member ReflectionProbe.box_projection]. - - + + If [code]true[/code], computes shadows in the reflection probe. This makes the reflection much slower to compute. Equivalent to [member ReflectionProbe.enable_shadows]. - - + + Sets the size of the area that the reflection probe will capture. Equivalent to [member ReflectionProbe.extents]. - - + + Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to [member ReflectionProbe.intensity]. - - + + Sets the max distance away from the probe an object can be before it is culled. Equivalent to [member ReflectionProbe.max_distance]. - - + + - - + + Sets the origin offset to be used when this reflection probe is in box project mode. Equivalent to [member ReflectionProbe.origin_offset]. - - + + - - + + Sets how often the reflection probe updates. Can either be once or every frame. See [enum ReflectionProbeUpdateMode] for options. - + Schedules a callback to the given callable after a frame has been drawn. @@ -2657,55 +2657,55 @@ - - + + - - + + Sets the environment that will be used with this scenario. - - + + Sets the fallback environment to be used by this scenario. The fallback environment is used if no environment is set. Internally, this is used by the editor to provide a default environment. - - - + + + - - - - + + + + Sets a boot image. The color defines the background color. If [code]scale[/code] is [code]true[/code], the image will be scaled to fit the screen size. If [code]use_filter[/code] is [code]true[/code], the image will be scaled with linear interpolation. If [code]use_filter[/code] is [code]false[/code], the image will be scaled with nearest-neighbor interpolation. - + If [code]true[/code], the engine will generate wireframes for use with the wireframe debug mode. - + Sets the default clear color which is used when a specific clear color has not been selected. @@ -2719,16 +2719,16 @@ - + Returns a shader's code. - - - + + + Returns a default texture from a shader searched by name. [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture. @@ -2736,31 +2736,31 @@ - - + + - + Returns the parameters of a shader. - - + + - - - - + + + + Sets a shader's default texture. Overwrites the texture given by name. [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture. @@ -2768,49 +2768,49 @@ - - + + - - - + + + - - + + Returns the [Transform3D] set for a specific bone of this skeleton. - - + + Returns the [Transform2D] set for a specific bone of this skeleton. - - - + + + Sets the [Transform3D] for a specific bone of this skeleton. - - - + + + Sets the [Transform2D] for a specific bone of this skeleton. @@ -2824,24 +2824,24 @@ - + Returns the number of bones allocated for this skeleton. - - + + - - - - + + + + @@ -2854,23 +2854,23 @@ - - + + Sets the material that the sky uses to render the background and reflection maps. - - + + - - + + @@ -2884,46 +2884,46 @@ - + - - + + - + - + - - + + - - + + - + @@ -2934,26 +2934,26 @@ - - - + + + - - - - - - + + + + + + - + @@ -2964,80 +2964,80 @@ - - + + - + - + - - + + - - + + - - + + - - + + - - - + + + - - + + Sets a viewport's camera. - - + + Sets a viewport's canvas. - - - + + + Copies the viewport to a region of the screen specified by [code]rect[/code]. If [method viewport_set_render_direct_to_screen] is [code]true[/code], then the viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to. For example, you can set the root viewport to not render at all with the following code: @@ -3061,53 +3061,53 @@ - + - + - - - + + + - + Returns the viewport's last rendered frame. - - + + Detaches a viewport from a canvas and vice versa. - - + + If [code]true[/code], sets the viewport active, else sets it inactive. - - - - + + + + Sets the stacking order for a viewport's canvas. [code]layer[/code] is the actual canvas layer, while [code]sublayer[/code] specifies the stacking order of the canvas among those in the same layer. @@ -3115,131 +3115,131 @@ - - - + + + Sets the transformation of a viewport's canvas. - - + + Sets the clear mode of a viewport. See [enum ViewportClearMode] for options. - - + + Sets the debug draw mode of a viewport. See [enum ViewportDebugDraw] for options. - - + + - - + + - - + + If [code]true[/code], the viewport's canvas is not rendered. - - + + - - + + If [code]true[/code], rendering of a viewport's environment is disabled. - - + + Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference. - - + + Sets the viewport's global transformation matrix. - - + + - - + + Sets the anti-aliasing mode. See [enum ViewportMSAA] for options. - + - + - - + + Sets the viewport's parent to another viewport. - - - + + + Sets the shadow atlas quadrant's subdivision. - - - + + + Sets the size of the shadow atlas's images (used for omni and spot lights). The value will be rounded up to the nearest power of 2. [b]Note:[/b] If this is set to [code]0[/code], no shadows will be visible at all (including directional shadows). @@ -3247,24 +3247,24 @@ - - + + If [code]true[/code], render the contents of the viewport directly to screen. This allows a low-level optimization where you can skip drawing a viewport to the root viewport. While this optimization can result in a significant increase in speed (especially on older devices), it comes at a cost of usability. When this is enabled, you cannot read from the viewport or from the [code]SCREEN_TEXTURE[/code]. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size. - - + + Sets scaling 3d mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. FSR should be used where possible. - - + + Scales the 3D render buffer based on the viewport size uses an image filter specified in [enum ViewportScaling3DMode] to scale the output image to the full viewport size. Values lower than [code]1.0[/code] can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than [code]1.0[/code] are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also [enum ViewportMSAA] for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons. When using FSR upscaling, AMD recommends exposing the following values as preset options to users "Ultra Quality: 0.77", "Quality: 0.67", "Balanced: 0.59", "Performance: 0.5" instead of exposing the entire scale. @@ -3272,8 +3272,8 @@ - - + + Sets a viewport's scenario. The scenario contains information about environment information, reflection atlas etc. @@ -3281,46 +3281,46 @@ - - + + - - - + + + - - - + + + Sets the viewport's width and height. - - + + - - + + - - + + Affects the final texture sharpness by reading from a lower or higher mipmap (also called "texture LOD bias"). Negative values make mipmapped textures sharper but grainier when viewed at a distance, while positive values make mipmapped textures blurrier (even when up close). To get sharper textures at a distance without introducing too much graininess, set this between [code]-0.75[/code] and [code]0.0[/code]. Enabling temporal antialiasing ([member ProjectSettings.rendering/anti_aliasing/quality/use_taa]) can help reduce the graininess visible when using negative mipmap bias. [b]Note:[/b] When the 3D scaling mode is set to FSR 1.0, this value is used to adjust the automatic mipmap bias which is calculated internally based on the scale factor. The formula for this is [code]-log2(1.0 / scale) + mipmap_bias[/code]. @@ -3328,62 +3328,62 @@ - - + + If [code]true[/code], the viewport renders its background as transparent. - - + + Sets when the viewport should be updated. See [enum ViewportUpdateMode] constants for options. - - + + - - + + - - + + If [code]true[/code], use Temporal Anti-Aliasing. - - + + If [code]true[/code], the viewport uses augmented or virtual reality technologies. See [XRInterface]. - - + + Sets the Variable Rate Shading (VRS) mode for the viewport. Note, if hardware does not support VRS this property is ignored. - - + + Texture to use when the VRS mode is set to [constant RenderingServer.VIEWPORT_VRS_TEXTURE]. @@ -3395,29 +3395,29 @@ - - + + - - - + + + - - - - - - - - + + + + + + + + @@ -3428,92 +3428,92 @@ - + - + - + - + - + - + - - + + - - + + - - + + - - + + - - + + - - + + - + - - + + diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index b08b1540ab..b5a2179463 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -19,7 +19,7 @@ - + Duplicates the resource, returning a new resource with the exported members copied. [b]Note:[/b] To duplicate the resource the constructor is called without arguments. This method will error when the constructor doesn't have default values. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing [code]true[/code] to the [code]subresources[/code] argument which will copy the subresources. @@ -60,7 +60,7 @@ - + Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting [member resource_path], as the latter would error out if another resource was already cached for the given path. diff --git a/doc/classes/ResourceFormatLoader.xml b/doc/classes/ResourceFormatLoader.xml index fef94b5f3b..cfa1b9f5d7 100644 --- a/doc/classes/ResourceFormatLoader.xml +++ b/doc/classes/ResourceFormatLoader.xml @@ -13,20 +13,20 @@ - + - + - - + + If implemented, gets the dependencies of a given resource. If [code]add_types[/code] is [code]true[/code], paths should be appended [code]::TypeName[/code], where [code]TypeName[/code] is the class name of the dependency. [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them. @@ -40,7 +40,7 @@ - + Gets the class name of the resource associated with the given path. If the loader cannot handle it, it should return [code]""[/code]. [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them. @@ -48,13 +48,13 @@ - + - + Tells which resource class this loader can load. [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just handle [code]"Resource"[/code] for them. @@ -62,10 +62,10 @@ - - - - + + + + Loads a resource when the engine finds this loader to be compatible. If the loaded resource is the result of an import, [code]original_path[/code] will target the source file. Returns a [Resource] object on success, or an [enum Error] constant in case of failure. The [code]cache_mode[/code] property defines whether and how the cache should be used or updated when loading the resource. See [enum CacheMode] for details. @@ -73,8 +73,8 @@ - - + + If implemented, renames dependencies within the given resource and saves it. [code]renames[/code] is a dictionary [code]{ String => String }[/code] mapping old dependency paths to new paths. Returns [constant OK] on success, or an [enum Error] constant in case of failure. diff --git a/doc/classes/ResourceFormatSaver.xml b/doc/classes/ResourceFormatSaver.xml index f9c4ca0d49..93f3a732bc 100644 --- a/doc/classes/ResourceFormatSaver.xml +++ b/doc/classes/ResourceFormatSaver.xml @@ -12,23 +12,23 @@ - + Returns the list of extensions available for saving the resource object, provided it is recognized (see [method _recognize]). - + Returns whether the given resource object can be saved by this saver. - - - + + + Saves the given resource object to a file at the target [code]path[/code]. [code]flags[/code] is a bitmask composed with [enum ResourceSaver.SaverFlags] constants. Returns [constant OK] on success, or an [enum Error] constant in case of failure. diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index 729058c9b3..1632be7e88 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -14,8 +14,8 @@ - - + + Registers a new [ResourceFormatLoader]. The ResourceLoader will use the ResourceFormatLoader as described in [method load]. This method is performed implicitly for ResourceFormatLoaders written in GDScript (see [ResourceFormatLoader] for more information). @@ -23,8 +23,8 @@ - - + + Returns whether a recognized resource exists for the given [code]path[/code]. An optional [code]type_hint[/code] can be used to further specify the [Resource] type that should be handled by the [ResourceFormatLoader]. Anything that inherits from [Resource] can be used as a type hint, for example [Image]. @@ -32,28 +32,28 @@ - + Returns the dependencies for the resource at the given [code]path[/code]. - + Returns the list of recognized extensions for a resource type. - + Returns the ID associated with a given resource path, or [code]-1[/code] when no such ID exists. - + Returns whether a cached resource is available for the given [code]path[/code]. Once a resource has been loaded by the engine, it is cached in memory for faster access, and future calls to the [method load] method will use the cached version. The cached resource can be overridden by using [method Resource.take_over_path] on a new resource for that same path. @@ -61,9 +61,9 @@ - - - + + + Loads a resource at the given [code]path[/code], caching the result for further access. The registered [ResourceFormatLoader]s are queried sequentially to find the first one which can handle the file's extension, and then attempt loading. If loading fails, the remaining ResourceFormatLoaders are also attempted. @@ -75,7 +75,7 @@ - + Returns the resource loaded by [method load_threaded_request]. If this is called before the loading thread is done (i.e. [method load_threaded_get_status] is not [constant THREAD_LOAD_LOADED]), the calling thread will be blocked until the resource has finished loading. @@ -83,8 +83,8 @@ - - + + Returns the status of a threaded loading operation started with [method load_threaded_request] for the resource at [code]path[/code]. See [enum ThreadLoadStatus] for possible return values. An array variable can optionally be passed via [code]progress[/code], and will return a one-element array containing the percentage of completion of the threaded loading. @@ -92,10 +92,10 @@ - - - - + + + + Loads the resource using threads. If [code]use_sub_threads[/code] is [code]true[/code], multiple threads will be used to load the resource, which makes loading faster, but may affect the main thread (and thus cause game slowdowns). The [code]cache_mode[/code] property defines whether and how the cache should be used or updated when loading the resource. See [enum CacheMode] for details. @@ -103,14 +103,14 @@ - + Unregisters the given [ResourceFormatLoader]. - + Changes the behavior on missing sub-resources. The default behavior is to abort loading. diff --git a/doc/classes/ResourcePreloader.xml b/doc/classes/ResourcePreloader.xml index 63db131cec..e52434c2a4 100644 --- a/doc/classes/ResourcePreloader.xml +++ b/doc/classes/ResourcePreloader.xml @@ -12,15 +12,15 @@ - - + + Adds a resource to the preloader with the given [code]name[/code]. If a resource with the given [code]name[/code] already exists, the new resource will be renamed to "[code]name[/code] N" where N is an incrementing number starting from 2. - + Returns the resource associated to [code]name[/code]. @@ -33,22 +33,22 @@ - + Returns [code]true[/code] if the preloader contains a resource associated to [code]name[/code]. - + Removes the resource associated to [code]name[/code] from the preloader. - - + + Renames a resource inside the preloader from [code]name[/code] to [code]newname[/code]. diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml index 10387a4f14..4c1fad22de 100644 --- a/doc/classes/ResourceSaver.xml +++ b/doc/classes/ResourceSaver.xml @@ -12,8 +12,8 @@ - - + + Registers a new [ResourceFormatSaver]. The ResourceSaver will use the ResourceFormatSaver as described in [method save]. This method is performed implicitly for ResourceFormatSavers written in GDScript (see [ResourceFormatSaver] for more information). @@ -21,23 +21,23 @@ - + Returns the list of extensions available for saving a resource of a given type. - + Unregisters the given [ResourceFormatSaver]. - - - + + + Saves a resource to disk to the given path, using a [ResourceFormatSaver] that recognizes the resource object. If [code]path[/code] is empty, [ResourceSaver] will try to use [member Resource.resource_path]. The [code]flags[/code] bitmask can be specified to customize the save behavior using [enum SaverFlags] flags. diff --git a/doc/classes/ResourceUID.xml b/doc/classes/ResourceUID.xml index 782a8a2968..7ac5dd58a8 100644 --- a/doc/classes/ResourceUID.xml +++ b/doc/classes/ResourceUID.xml @@ -13,8 +13,8 @@ - - + + Adds a new UID value which is mapped to the given resource path. Fails with an error if the UID already exists, so be sure to check [method has_id] beforehand, or use [method set_id] instead. @@ -29,7 +29,7 @@ - + Returns the path that the given UID value refers to. Fails with an error if the UID does not exist, so be sure to check [method has_id] beforehand. @@ -37,21 +37,21 @@ - + Returns whether the given UID value is known to the cache. - + Converts the given UID to a [code]uid://[/code] string value. - + Removes a loaded UID value from the cache. Fails with an error if the UID does not exist, so be sure to check [method has_id] beforehand. @@ -59,8 +59,8 @@ - - + + Updates the resource path of an existing UID. Fails with an error if the UID does not exist, so be sure to check [method has_id] beforehand, or use [method add_id] instead. @@ -68,7 +68,7 @@ - + Extracts the UID value from the given [code]uid://[/code] string. diff --git a/doc/classes/RichTextEffect.xml b/doc/classes/RichTextEffect.xml index 2256839378..304950d97c 100644 --- a/doc/classes/RichTextEffect.xml +++ b/doc/classes/RichTextEffect.xml @@ -25,7 +25,7 @@ - + Override this method to modify properties in [code]char_fx[/code]. The method must return [code]true[/code] if the character could be transformed successfully. If the method returns [code]false[/code], it will skip transformation to avoid displaying broken text. diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 8228bcc442..ef01eba49d 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -18,11 +18,11 @@ - - - - - + + + + + Adds an image's opening and closing tags to the tag stack, optionally providing a [code]width[/code] and [code]height[/code] to resize the image and a [code]color[/code] to tint the image. If [code]width[/code] or [code]height[/code] is set to 0, the image size will be adjusted in order to keep the original aspect ratio. @@ -30,14 +30,14 @@ - + Adds raw non-BBCode-parsed text to the tag stack. - + Parses [code]bbcode[/code] and adds tags to the tag stack as needed. [b]Note:[/b] Using this method, you can't close a tag that was opened in a previous [method append_text] call. This is done to improve performance, especially when updating large RichTextLabels since rebuilding the whole BBCode every time would be slower. If you absolutely need to close a tag in a future method call, append the [member text] instead of using [method append_text]. @@ -57,7 +57,7 @@ - + Returns the line number of the character position provided. [b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded. @@ -65,7 +65,7 @@ - + Returns the paragraph number of the character position provided. [b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded. @@ -94,7 +94,7 @@ - + Returns the vertical offset of the line found at the provided index. [b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded. @@ -115,7 +115,7 @@ - + Returns the vertical offset of the paragraph found at the provided index. [b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded. @@ -174,7 +174,7 @@ - + Installs a custom effect. [code]effect[/code] should be a valid [RichTextEffect]. @@ -199,14 +199,14 @@ - + The assignment version of [method append_text]. Clears the tag stack and inserts the new content. - + Parses BBCode parameter [code]expressions[/code] into a dictionary. @@ -219,7 +219,7 @@ - + Adds a [code][bgcolor][/code] tag to the tag stack. @@ -244,55 +244,55 @@ - + Adds a [code][color][/code] tag to the tag stack. - - - - - - - + + + + + + + Adds a [code][dropcap][/code] tag to the tag stack. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text. - + Adds a [code][fgcolor][/code] tag to the tag stack. - - + + Adds a [code][font][/code] tag to the tag stack. Overrides default fonts for its duration. - + - + Adds a [code][hint][/code] tag to the tag stack. Same as BBCode [code][hint=something]{text}[/hint][/code]. - + Adds an [code][indent][/code] tag to the tag stack. Multiplies [code]level[/code] by current [member tab_size] to determine new margin length. @@ -305,16 +305,16 @@ - - - + + + Adds [code][ol][/code] or [code][ul][/code] tag to the tag stack. Multiplies [code]level[/code] by current [member tab_size] to determine new margin length. - + Adds a [code][meta][/code] tag to the tag stack. Similar to the BBCode [code][url=something]{text}[/url][/code], but supports non-[String] metadata types. @@ -333,24 +333,24 @@ - + Adds a [code][outline_color][/code] tag to the tag stack. Adds text outline for its duration. - + Adds a [code][outline_size][/code] tag to the tag stack. Overrides default text outline size for its duration. - - - - + + + + Adds a [code][p][/code] tag to the tag stack. @@ -363,8 +363,8 @@ - - + + Adds a [code][table=columns,inline_align][/code] tag to the tag stack. @@ -377,7 +377,7 @@ - + Removes a line of content from the label. Returns [code]true[/code] if the line exists. The [code]line[/code] argument is the index of the line to remove, it can take values in the interval [code][0, get_line_count() - 1][/code]. @@ -385,14 +385,14 @@ - + Scrolls the window's top line to match [code]line[/code]. - + Scrolls the window's top line to match first line of the [code]paragraph[/code]. @@ -406,39 +406,39 @@ - + Sets color of a table cell border. - + Sets inner padding of a table cell. - - + + Sets color of a table cell. Separate colors for alternating rows can be specified. - - + + Sets minimum and maximum size overrides for a table cell. - - - + + + Edits the selected column's expansion options. If [code]expand[/code] is [code]true[/code], the column expands in proportion to its expansion ratio versus the other columns' ratios. For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width would expand 30 and 40 pixels, respectively. @@ -534,19 +534,19 @@ - + Triggered when the user clicks on content between meta tags. If the meta is defined in text, e.g. [code][url={"data"="hi"}]hi[/url][/code], then the parameter for this signal will be a [String] type. If a particular type or an object is desired, the [method push_meta] method must be used to manually insert the data into the tag stack. - + Triggers when the mouse exits a meta tag. - + Triggers when the mouse enters a meta tag. diff --git a/doc/classes/RigidDynamicBody2D.xml b/doc/classes/RigidDynamicBody2D.xml index 087156989e..c50da89a26 100644 --- a/doc/classes/RigidDynamicBody2D.xml +++ b/doc/classes/RigidDynamicBody2D.xml @@ -17,14 +17,14 @@ - + Allows you to read and safely modify the simulation state for the object. Use this instead of [method Node._physics_process] if you need to directly change the body's [code]position[/code] or other physics properties. By default, it works in addition to the usual physics behavior, but [member custom_integrator] allows you to disable the default behavior and write custom force integration for a body. - + Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]constant_force = Vector2(0, 0)[/code]. This is equivalent to using [method add_constant_force] at the body's center of mass. @@ -32,8 +32,8 @@ - - + + Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]constant_force = Vector2(0, 0)[/code]. [code]position[/code] is the offset from the body origin in global coordinates. @@ -41,14 +41,14 @@ - + Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]constant_torque = 0[/code]. - + Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. This is equivalent to using [method apply_force] at the body's center of mass. @@ -56,7 +56,7 @@ - + Applies a directional impulse without affecting rotation. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -65,8 +65,8 @@ - - + + Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. [code]position[/code] is the offset from the body origin in global coordinates. @@ -74,8 +74,8 @@ - - + + Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -84,14 +84,14 @@ - + Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. - + Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -106,7 +106,7 @@ - + Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. @@ -197,24 +197,24 @@ - + Emitted when a collision with another [PhysicsBody2D] or [TileMap] occurs. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. - + Emitted when the collision with another [PhysicsBody2D] or [TileMap] ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. - - - - + + + + Emitted when one of this RigidDynamicBody2D's [Shape2D]s collides with another [PhysicsBody2D] or [TileMap]'s [Shape2D]s. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_rid[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. @@ -224,10 +224,10 @@ - - - - + + + + Emitted when the collision between one of this RigidDynamicBody2D's [Shape2D]s and another [PhysicsBody2D] or [TileMap]'s [Shape2D]s ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_rid[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. diff --git a/doc/classes/RigidDynamicBody3D.xml b/doc/classes/RigidDynamicBody3D.xml index 285176b8b0..5c89dbbf44 100644 --- a/doc/classes/RigidDynamicBody3D.xml +++ b/doc/classes/RigidDynamicBody3D.xml @@ -17,14 +17,14 @@ - + Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it works in addition to the usual physics behavior, but the [member custom_integrator] property allows you to disable the default behavior and do fully custom force integration for a body. - + Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with [code]constant_force = Vector3(0, 0, 0)[/code]. This is equivalent to using [method add_constant_force] at the body's center of mass. @@ -32,8 +32,8 @@ - - + + Adds a constant positioned force to the body that keeps being applied over time until cleared with [code]constant_force = Vector3(0, 0, 0)[/code]. [code]position[/code] is the offset from the body origin in global coordinates. @@ -41,14 +41,14 @@ - + Adds a constant rotational force without affecting position that keeps being applied over time until cleared with [code]constant_torque = Vector3(0, 0, 0)[/code]. - + Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. This is equivalent to using [method apply_force] at the body's center of mass. @@ -56,7 +56,7 @@ - + Applies a directional impulse without affecting rotation. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -65,8 +65,8 @@ - - + + Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. [code]position[/code] is the offset from the body origin in global coordinates. @@ -74,8 +74,8 @@ - - + + Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -84,14 +84,14 @@ - + Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. - + Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). @@ -112,7 +112,7 @@ - + Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. @@ -203,24 +203,24 @@ - + Emitted when a collision with another [PhysicsBody3D] or [GridMap] occurs. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. - + Emitted when the collision with another [PhysicsBody3D] or [GridMap] ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. - - - - + + + + Emitted when one of this RigidDynamicBody3D's [Shape3D]s collides with another [PhysicsBody3D] or [GridMap]'s [Shape3D]s. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body_rid[/code] the [RID] of the other [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. @@ -230,10 +230,10 @@ - - - - + + + + Emitted when the collision between one of this RigidDynamicBody3D's [Shape3D]s and another [PhysicsBody3D] or [GridMap]'s [Shape3D]s ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. [code]body_rid[/code] the [RID] of the other [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [GridMap]s are detected if the Meshes have [Shape3D]s. diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml index d226577a95..f171d29b84 100644 --- a/doc/classes/SceneState.xml +++ b/doc/classes/SceneState.xml @@ -12,7 +12,7 @@ - + Returns the list of bound parameters for the signal at [code]idx[/code]. @@ -26,42 +26,42 @@ - + Returns the connection flags for the signal at [code]idx[/code]. See [enum Object.ConnectFlags] constants. - + Returns the method connected to the signal at [code]idx[/code]. - + Returns the name of the signal at [code]idx[/code]. - + Returns the path to the node that owns the signal at [code]idx[/code], relative to the root node. - + Returns the path to the node that owns the method connected to the signal at [code]idx[/code], relative to the root node. - + Returns the number of unbound parameters for the signal at [code]idx[/code]. @@ -75,50 +75,50 @@ - + Returns the list of group names associated with the node at [code]idx[/code]. - + Returns the node's index, which is its position relative to its siblings. This is only relevant and saved in scenes for cases where new nodes are added to an instantiated or inherited scene among siblings from the base scene. Despite the name, this index is not related to the [code]idx[/code] argument used here and in other methods. - + Returns a [PackedScene] for the node at [code]idx[/code] (i.e. the whole branch starting at this node, with its child nodes and resources), or [code]null[/code] if the node is not an instance. - + Returns the path to the represented scene file if the node at [code]idx[/code] is an [InstancePlaceholder]. - + Returns the name of the node at [code]idx[/code]. - + Returns the path to the owner of the node at [code]idx[/code], relative to the root node. - - + + Returns the path to the node at [code]idx[/code]. If [code]for_parent[/code] is [code]true[/code], returns the path of the [code]idx[/code] node's parent instead. @@ -126,7 +126,7 @@ - + Returns the number of exported or overridden properties for the node at [code]idx[/code]. The [code]prop_idx[/code] argument used to query node property data in other [code]get_node_property_*[/code] methods in the interval [code][0, get_node_property_count() - 1][/code]. @@ -134,30 +134,30 @@ - - + + Returns the name of the property at [code]prop_idx[/code] for the node at [code]idx[/code]. - - + + Returns the value of the property at [code]prop_idx[/code] for the node at [code]idx[/code]. - + Returns the type of the node at [code]idx[/code]. - + Returns [code]true[/code] if the node at [code]idx[/code] is an [InstancePlaceholder]. diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 9982cc0d60..dfa5704548 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -15,8 +15,8 @@ - - + + Calls [code]method[/code] on each member of the given group. You can pass arguments to [code]method[/code] by specifying them at the end of the method call. If a node doesn't have the given method or the argument list does not match (either in count or in types), it will be skipped. [b]Note:[/b] [method call_group] will call methods immediately on all members at once, which can cause stuttering if an expensive method is called on lots of members. To wait for one frame after [method call_group] was called, use [method call_group_flags] with the [constant GROUP_CALL_DEFERRED] flag. @@ -24,9 +24,9 @@ - - - + + + Calls [code]method[/code] on each member of the given group, respecting the given [enum GroupCallFlags]. You can pass arguments to [code]method[/code] by specifying them at the end of the method call. If a node doesn't have the given method or the argument list does not match (either in count or in types), it will be skipped. [codeblock] @@ -38,7 +38,7 @@ - + Changes the running scene to the one at the given [code]path[/code], after loading it into a [PackedScene] and creating a new instance. Returns [constant OK] on success, [constant ERR_CANT_OPEN] if the [code]path[/code] cannot be loaded into a [PackedScene], or [constant ERR_CANT_CREATE] if that scene cannot be instantiated. @@ -47,7 +47,7 @@ - + Changes the running scene to a new instance of the given [PackedScene]. Returns [constant OK] on success or [constant ERR_CANT_CREATE] if the scene cannot be instantiated. @@ -56,8 +56,8 @@ - - + + Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this [SceneTree]. If [code]process_always[/code] is set to [code]false[/code], pausing the [SceneTree] will also pause the timer. Commonly used to create a one-shot delay timer as in the following example: @@ -88,7 +88,7 @@ - + Returns the first node in the specified group, or [code]null[/code] if the group is empty or does not exist. @@ -101,7 +101,7 @@ - + Return the [MultiplayerAPI] configured for the given path, or the default one if [code]for_path[/code] is empty. @@ -114,7 +114,7 @@ - + Returns a list of all nodes assigned to the given group. @@ -127,15 +127,15 @@ - + Returns [code]true[/code] if the given group exists. - - + + Sends the given notification to all members of the [code]group[/code]. [b]Note:[/b] [method notify_group] will immediately notify all members at once, which can cause stuttering if an expensive method is called as a result of sending the notification lots of members. To wait for one frame, use [method notify_group_flags] with the [constant GROUP_CALL_DEFERRED] flag. @@ -143,9 +143,9 @@ - - - + + + Sends the given notification to all members of the [code]group[/code], respecting the given [enum GroupCallFlags]. [b]Note:[/b] Group call flags are used to control the notification sending behavior. By default, notifications will be sent immediately in a way similar to [method notify_group]. However, if the [constant GROUP_CALL_DEFERRED] flag is present in the [code]flags[/code] argument, notifications will be sent with a one-frame delay in a way similar to using [code]Object.call_deferred("notification", ...)[/code]. @@ -153,14 +153,14 @@ - + Queues the given object for deletion, delaying the call to [method Object.free] to after the current frame. - + Quits the application at the end of the current iteration. Argument [code]exit_code[/code] can optionally be given (defaulting to 0) to customize the exit status code. By convention, an exit code of [code]0[/code] indicates success whereas a non-zero exit code indicates an error. @@ -177,9 +177,9 @@ - - - + + + Sets the given [code]property[/code] to [code]value[/code] on all members of the given group. [b]Note:[/b] [method set_group] will set the property immediately on all members at once, which can cause stuttering if a property with an expensive setter is set on lots of members. To wait for one frame, use [method set_group_flags] with the [constant GROUP_CALL_DEFERRED] flag. @@ -187,10 +187,10 @@ - - - - + + + + Sets the given [code]property[/code] to [code]value[/code] on all members of the given group, respecting the given [enum GroupCallFlags]. [b]Note:[/b] Group call flags are used to control the property setting behavior. By default, properties will be set immediately in a way similar to [method set_group]. However, if the [constant GROUP_CALL_DEFERRED] flag is present in the [code]flags[/code] argument, properties will be set with a one-frame delay in a way similar to [method Object.call_deferred]. @@ -198,8 +198,8 @@ - - + + Sets a custom [MultiplayerAPI] with the given [code]root_path[/code] (controlling also the relative subpaths), or override the default one if [code]root_path[/code] is empty. @@ -244,25 +244,25 @@ - + Emitted whenever a node is added to the [SceneTree]. - + Emitted when a node's configuration changed. Only emitted in [code]tool[/code] mode. - + Emitted whenever a node is removed from the [SceneTree]. - + Emitted whenever a node is renamed. diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index cd8841c8c5..f567a0c23c 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -32,7 +32,7 @@ - + Returns the default value of the specified property. @@ -63,7 +63,7 @@ - + Returns [code]true[/code] if the script, or a base class, defines a signal with the given name. @@ -76,7 +76,7 @@ - + Returns [code]true[/code] if [code]base_object[/code] is an instance of this script. @@ -89,7 +89,7 @@ - + Reloads the script's class implementation. Returns an error code. diff --git a/doc/classes/ScriptCreateDialog.xml b/doc/classes/ScriptCreateDialog.xml index 79ee95719d..6b608aca4f 100644 --- a/doc/classes/ScriptCreateDialog.xml +++ b/doc/classes/ScriptCreateDialog.xml @@ -29,10 +29,10 @@ - - - - + + + + Prefills required fields to configure the ScriptCreateDialog for use. @@ -45,7 +45,7 @@ - + Emitted when the user clicks the OK button. diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml index 92488b2392..33ff054cce 100644 --- a/doc/classes/ScriptEditor.xml +++ b/doc/classes/ScriptEditor.xml @@ -35,22 +35,22 @@ - + Goes to the specified line in the current script. - - + + Opens the script create dialog. The script will extend [code]base_name[/code]. The file extension can be omitted from [code]base_path[/code]. It will be added based on the selected scripting language. - + Registers the [EditorSyntaxHighlighter] to the editor, the [EditorSyntaxHighlighter] will be available on all open scripts. [b]Note:[/b] Does not apply to scripts that are already opened. @@ -58,7 +58,7 @@ - + Unregisters the [EditorSyntaxHighlighter] from the editor. [b]Note:[/b] The [EditorSyntaxHighlighter] will still be applied to scripts that are already opened. @@ -67,13 +67,13 @@ - + Emitted when user changed active script. Argument is a freshly activated [Script]. - + Emitted when editor is about to close the active script. Argument is a [Script] that is going to be closed. diff --git a/doc/classes/ScriptEditorBase.xml b/doc/classes/ScriptEditorBase.xml index 3bed1127ee..c365e0971b 100644 --- a/doc/classes/ScriptEditorBase.xml +++ b/doc/classes/ScriptEditorBase.xml @@ -11,7 +11,7 @@ - + Adds a [EditorSyntaxHighlighter] to the open script. @@ -30,7 +30,7 @@ - + Emitted when the user requests a specific documentation page. @@ -41,20 +41,20 @@ - + Emitted when the user request to find and replace text in the file system. Not used by visual scripts. - + Emitted when the user requests contextual help. - - + + Emitted when the user requests a script. @@ -65,7 +65,7 @@ - + Emitted when the user request to search text in the file system. Not used by visual scripts. diff --git a/doc/classes/ScriptExtension.xml b/doc/classes/ScriptExtension.xml index 4e432ca9a8..b59c49d785 100644 --- a/doc/classes/ScriptExtension.xml +++ b/doc/classes/ScriptExtension.xml @@ -44,7 +44,7 @@ - + @@ -55,13 +55,13 @@ - + - + @@ -92,13 +92,13 @@ - + - + @@ -109,19 +109,19 @@ - + - + - + @@ -142,25 +142,25 @@ - + - + - + - + diff --git a/doc/classes/ScriptLanguageExtension.xml b/doc/classes/ScriptLanguageExtension.xml index 45d4cf44fa..2d41f8e880 100644 --- a/doc/classes/ScriptLanguageExtension.xml +++ b/doc/classes/ScriptLanguageExtension.xml @@ -9,29 +9,29 @@ - - + + - - + + - + - - - + + + @@ -42,9 +42,9 @@ - - - + + + @@ -65,8 +65,8 @@ - - + + @@ -77,57 +77,57 @@ - + - + - + - - - + + + - - - + + + - - - - + + + + - + - - + + @@ -143,13 +143,13 @@ - + - + @@ -165,7 +165,7 @@ - + @@ -211,7 +211,7 @@ - + @@ -227,7 +227,7 @@ - + @@ -238,34 +238,34 @@ - - - - + + + + - - - + + + - - - + + + - - - + + + @@ -276,15 +276,15 @@ - - + + - - + + @@ -300,13 +300,13 @@ - + - + @@ -317,14 +317,14 @@ - - + + - + @@ -350,18 +350,18 @@ - - - - - - + + + + + + - + diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 1bbf5cb91b..207a745696 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -14,7 +14,7 @@ - + Ensures the given [code]control[/code] is visible (must be a direct or indirect child of the ScrollContainer). Used by [member follow_focus]. [b]Note:[/b] This will not work on a node that was just added during the same frame. If you want to scroll to a newly added child, you must wait until the next frame using [signal SceneTree.process_frame]: diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index 1921c5b91d..6390d36bf1 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -12,8 +12,8 @@ - - + + Returns the texture that is set as default for the specified parameter. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. @@ -28,7 +28,7 @@ - + Returns [code]true[/code] if the shader has this param defined as a uniform in its code. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. @@ -36,9 +36,9 @@ - - - + + + Sets the default texture to be used with a texture uniform. The default is used if a texture is not set in the [ShaderMaterial]. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index 1208b93a62..3e2247c022 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -12,29 +12,29 @@ - + Returns the current value set for this material of a uniform in the shader. - + Returns [code]true[/code] if the property identified by [code]name[/code] can be reverted to a default value. - + Returns the default value of the material property with given [code]name[/code]. - - + + Changes the value set for this material of a uniform in the shader. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index 94fb2d7dc7..8f5ca034e4 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -12,9 +12,9 @@ - - - + + + Returns [code]true[/code] if this shape is colliding with another. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). @@ -22,9 +22,9 @@ - - - + + + Returns a list of contact point pairs where this shape touches another. If there are no collisions, the returned list is empty. Otherwise, the returned list contains contact points arranged in pairs, with entries alternating between points on the boundary of this shape and points on the boundary of [code]with_shape[/code]. @@ -34,11 +34,11 @@ - - - - - + + + + + Returns whether this shape would collide with another, if a given movement was applied. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). @@ -46,11 +46,11 @@ - - - - - + + + + + Returns a list of contact point pairs where this shape would touch another, if a given movement was applied. If there would be no collisions, the returned list is empty. Otherwise, the returned list contains contact points arranged in pairs, with entries alternating between points on the boundary of this shape and points on the boundary of [code]with_shape[/code]. @@ -60,8 +60,8 @@ - - + + Draws a solid shape onto a [CanvasItem] with the [RenderingServer] API filled with the specified [code]color[/code]. The exact drawing method is specific for each shape and cannot be configured. diff --git a/doc/classes/ShapeCast2D.xml b/doc/classes/ShapeCast2D.xml index 70da03dc6e..652cacfb53 100644 --- a/doc/classes/ShapeCast2D.xml +++ b/doc/classes/ShapeCast2D.xml @@ -14,14 +14,14 @@ - + Adds a collision exception so the shape does not report collisions with the specified [CollisionObject2D] node. - + Adds a collision exception so the shape does not report collisions with the specified [RID]. @@ -53,14 +53,14 @@ - + Returns the collided [Object] of one of the multiple collisions at [code]index[/code], or [code]null[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]). - + Returns the shape ID of the colliding shape of one of the multiple collisions at [code]index[/code], or [code]0[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]). @@ -73,21 +73,21 @@ - + Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. - + Returns the normal of one of the multiple collisions at [code]index[/code] of the intersecting object. - + Returns the collision point of one of the multiple collisions at [code]index[/code] where the shape intersects the colliding object. [b]Note:[/b] this point is in the [b]global[/b] coordinate system. @@ -101,22 +101,22 @@ - + Removes a collision exception so the shape does report collisions with the specified [CollisionObject2D] node. - + Removes a collision exception so the shape does report collisions with the specified [RID]. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. diff --git a/doc/classes/ShapeCast3D.xml b/doc/classes/ShapeCast3D.xml index 085bc9acd1..9a5606e198 100644 --- a/doc/classes/ShapeCast3D.xml +++ b/doc/classes/ShapeCast3D.xml @@ -14,14 +14,14 @@ - + Adds a collision exception so the shape does not report collisions with the specified [CollisionObject3D] node. - + Adds a collision exception so the shape does not report collisions with the specified [RID]. @@ -53,14 +53,14 @@ - + Returns the collided [Object] of one of the multiple collisions at [code]index[/code], or [code]null[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]). - + Returns the shape ID of the colliding shape of one of the multiple collisions at [code]index[/code], or [code]0[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]). @@ -73,21 +73,21 @@ - + Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. - + Returns the normal of one of the multiple collisions at [code]index[/code] of the intersecting object. - + Returns the collision point of one of the multiple collisions at [code]index[/code] where the shape intersects the colliding object. [b]Note:[/b] this point is in the [b]global[/b] coordinate system. @@ -101,29 +101,29 @@ - + Removes a collision exception so the shape does report collisions with the specified [CollisionObject3D] node. - + Removes a collision exception so the shape does report collisions with the specified [RID]. - + This method is used internally to update the debug gizmo in the editor. Any code placed in this function will be called whenever the [member shape] resource is modified. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. diff --git a/doc/classes/Shortcut.xml b/doc/classes/Shortcut.xml index 46524a1d74..329471fdb8 100644 --- a/doc/classes/Shortcut.xml +++ b/doc/classes/Shortcut.xml @@ -24,7 +24,7 @@ - + Returns whether any [InputEvent] in [member events] equals [code]event[/code]. diff --git a/doc/classes/Signal.xml b/doc/classes/Signal.xml index 049e7f8777..dc543085cf 100644 --- a/doc/classes/Signal.xml +++ b/doc/classes/Signal.xml @@ -18,15 +18,15 @@ - + Constructs a [Signal] as a copy of the given [Signal]. - - + + Creates a new [Signal] with the name [code]signal[/code] in the specified [code]object[/code]. @@ -35,8 +35,8 @@ - - + + Connects this signal to the specified [Callable], optionally providing connection flags. You can provide additional arguments to the connected method call by using [method Callable.bind]. [codeblock] @@ -50,7 +50,7 @@ - + Disconnects this signal from the specified [Callable]. @@ -87,7 +87,7 @@ - + Returns [code]true[/code] if the specified [Callable] is connected to this signal. @@ -101,13 +101,13 @@ - + - + diff --git a/doc/classes/Skeleton2D.xml b/doc/classes/Skeleton2D.xml index 7867e5afa3..0abb8be075 100644 --- a/doc/classes/Skeleton2D.xml +++ b/doc/classes/Skeleton2D.xml @@ -13,15 +13,15 @@ - - + + Executes all the modifications on the [SkeletonModificationStack2D], if the Skeleton3D has one assigned. - + Returns a [Bone2D] from the node hierarchy parented by Skeleton2D. The object to return is identified by the parameter [code]idx[/code]. Bones are indexed by descending the node hierarchy from top to bottom, adding the children of each branch before moving to the next sibling. @@ -34,7 +34,7 @@ - + Returns the local pose override transform for [code]bone_idx[/code]. @@ -53,10 +53,10 @@ - - - - + + + + Sets the local pose transform, [code]pose[/code], for the bone at [code]bone_idx[/code]. [code]amount[/code] is the interpolation strength that will be used when applying the pose, and [code]persistent[/code] determines if the applied pose will remain. @@ -65,7 +65,7 @@ - + Sets the [SkeletonModificationStack2D] attached to this skeleton. diff --git a/doc/classes/Skeleton3D.xml b/doc/classes/Skeleton3D.xml index 6295724aa2..c02a482a91 100644 --- a/doc/classes/Skeleton3D.xml +++ b/doc/classes/Skeleton3D.xml @@ -15,15 +15,15 @@ - + Adds a bone, with name [code]name[/code]. [method get_bone_count] will become the bone index. - - + + Takes the given bone pose/transform and converts it to a world transform, relative to the [Skeleton3D] node. This is useful for using the bone transform in calculations with transforms from [Node3D]-based nodes. @@ -54,15 +54,15 @@ - - + + Executes all the modifications on the [SkeletonModificationStack3D], if the Skeleton3D has one assigned. - + Returns the bone index that matches [code]name[/code] as its name. @@ -75,14 +75,14 @@ - + Force updates the bone transform for the bone at [code]bone_idx[/code] and all of its children. - + Returns an array containing the bone indexes of all the children node of the passed in bone, [code]bone_idx[/code]. @@ -95,49 +95,49 @@ - + Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. - + Returns the overall transform of the specified bone, with respect to the skeleton, but without any global pose overrides. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. - + Returns the global pose override transform for [code]bone_idx[/code]. - + Returns the global rest transform for [code]bone_idx[/code]. - + Returns the local pose override transform for [code]bone_idx[/code]. - + Returns the name of the bone at index [code]index[/code]. - + Returns the bone index which is the parent of the bone at [code]bone_idx[/code]. If -1, then bone has no parent. [b]Note:[/b] The parent bone returned will always be less than [code]bone_idx[/code]. @@ -145,32 +145,32 @@ - + Returns the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. - + - + - + - + Returns the rest transform for a bone [code]bone_idx[/code]. @@ -189,8 +189,8 @@ - - + + Takes the passed-in global pose and converts it to local pose transform. This can be used to easily convert a global pose from [method get_bone_global_pose] to a global transform in [method set_bone_local_pose_override]. @@ -198,7 +198,7 @@ - + Takes the passed-in global pose and converts it to a world transform. This can be used to easily convert a global pose from [method get_bone_global_pose] to a global transform usable with a node's transform, like [member Node3D.global_transform] for example. @@ -206,8 +206,8 @@ - - + + Rotates the given [Basis] so that the forward axis of the Basis is facing in the forward direction of the bone at [code]bone_idx[/code]. This is helper function to make using [method Transform3D.looking_at] easier with bone poses. @@ -215,15 +215,15 @@ - + Returns whether the bone pose for the bone at [code]bone_idx[/code] is enabled. - - + + Converts the passed-in local pose to a global pose relative to the inputted bone, [code]bone_idx[/code]. This could be used to convert [method get_bone_pose] for use with the [method set_bone_global_pose_override] function. @@ -237,7 +237,7 @@ - + Adds a collision exception to the physical bone. Works just like the [RigidDynamicBody3D] node. @@ -245,7 +245,7 @@ - + Removes a collision exception to the physical bone. Works just like the [RigidDynamicBody3D] node. @@ -253,7 +253,7 @@ - + Tells the [PhysicalBone3D] nodes in the Skeleton to start simulating and reacting to the physics world. Optionally, a list of bone names can be passed-in, allowing only the passed-in bones to be simulated. @@ -267,15 +267,15 @@ - + Binds the given Skin to the Skeleton. - - + + Removes the passed in child bone index, [code]child_bone_idx[/code], from the passed-in bone, [code]bone_idx[/code], if it exists. [b]Note:[/b] This does not remove the child bone, but instead it removes the connection it has to the parent bone. @@ -283,26 +283,26 @@ - - + + Sets the children for the passed in bone, [code]bone_idx[/code], to the passed-in array of bone indexes, [code]bone_children[/code]. - - + + Disables the pose for the bone at [code]bone_idx[/code] if [code]false[/code], enables the bone pose if [code]true[/code]. - - - - + + + + Sets the global pose transform, [code]pose[/code], for the bone at [code]bone_idx[/code]. [code]amount[/code] is the interpolation strength that will be used when applying the pose, and [code]persistent[/code] determines if the applied pose will remain. @@ -311,10 +311,10 @@ - - - - + + + + Sets the local pose transform, [code]pose[/code], for the bone at [code]bone_idx[/code]. [code]amount[/code] is the interpolation strength that will be used when applying the pose, and [code]persistent[/code] determines if the applied pose will remain. @@ -323,15 +323,15 @@ - - + + - - + + Sets the bone index [code]parent_idx[/code] as the parent of the bone at [code]bone_idx[/code]. If -1, then bone has no parent. [b]Note:[/b] [code]parent_idx[/code] must be less than [code]bone_idx[/code]. @@ -339,50 +339,50 @@ - - + + - - + + - - + + - - + + Sets the rest transform for bone [code]bone_idx[/code]. - + Sets the modification stack for this skeleton to the passed-in modification stack, [code]modification_stack[/code]. - + Unparents the bone at [code]bone_idx[/code] and sets its rest position to that of its parent prior to being reset. - + Takes the passed-in global transform and converts it to a global pose. This can be used to easily convert a global transform from [member Node3D.global_transform] to a global pose usable with [method set_bone_global_pose_override], for example. @@ -401,12 +401,12 @@ - + - + This signal is emitted when one of the bones in the Skeleton3D node have changed their pose. This is used to inform nodes that rely on bone positions that one of the bones in the Skeleton3D have changed their transform/pose. diff --git a/doc/classes/SkeletonIK3D.xml b/doc/classes/SkeletonIK3D.xml index 0545469e4c..788ba3e248 100644 --- a/doc/classes/SkeletonIK3D.xml +++ b/doc/classes/SkeletonIK3D.xml @@ -20,7 +20,7 @@ - + diff --git a/doc/classes/SkeletonModification2D.xml b/doc/classes/SkeletonModification2D.xml index 8ce9bf5731..c9171ead51 100644 --- a/doc/classes/SkeletonModification2D.xml +++ b/doc/classes/SkeletonModification2D.xml @@ -19,24 +19,24 @@ - + Executes the given modification. This is where the modification performs whatever function it is designed to do. - + Called when the modification is setup. This is where the modification performs initialization. - - - - + + + + Takes a angle and clamps it so it is within the passed-in [code]min[/code] and [code]max[/code] range. [code]invert[/code] will inversely clamp the angle, clamping it to the range outside of the given bounds. @@ -61,14 +61,14 @@ - + Sets whether this modification will call [method _draw_editor_gizmo] in the Godot editor to draw modification-specific gizmos. - + Manually allows you to set the setup state of the modification. This function should only rarely be used, as the [SkeletonModificationStack2D] the modification is bound to should handle setting the modification up. diff --git a/doc/classes/SkeletonModification2DCCDIK.xml b/doc/classes/SkeletonModification2DCCDIK.xml index a613787a3e..048d5cb397 100644 --- a/doc/classes/SkeletonModification2DCCDIK.xml +++ b/doc/classes/SkeletonModification2DCCDIK.xml @@ -14,73 +14,73 @@ - + Returns the [Bone2D] node assigned to the CCDIK joint at [code]joint_idx[/code]. - + Returns the index of the [Bone2D] node assigned to the CCDIK joint at [code]joint_idx[/code]. - + Returns whether the CCDIK joint at [code]joint_idx[/code] uses an inverted joint constraint. See [method set_ccdik_joint_constraint_angle_invert] for details. - + Returns the maximum angle constraint for the joint at [code]joint_idx[/code]. - + Returns the minimum angle constraint for the joint at [code]joint_idx[/code]. - + Returns whether angle constraints on the CCDIK joint at [code]joint_idx[/code] are enabled. - + Returns whether the joint at [code]joint_idx[/code] is set to rotate from the joint, [code]true[/code], or to rotate from the tip, [code]false[/code]. The default is to rotate from the tip. - - + + Sets the [Bone2D] node assigned to the CCDIK joint at [code]joint_idx[/code]. - - + + Sets the bone index, [code]bone_index[/code], of the CCDIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone2d_node[/code] of the CCDIK joint based on data provided by the linked skeleton. - - + + Sets whether the CCDIK joint at [code]joint_idx[/code] uses an inverted joint constraint. An inverted joint constraint only constraints the CCDIK joint to the angles [i]outside of[/i] the inputted minimum and maximum angles. For this reason, it is referred to as an inverted joint constraint, as it constraints the joint to the outside of the inputted values. @@ -88,32 +88,32 @@ - - + + Sets the maximum angle constraint for the joint at [code]joint_idx[/code]. - - + + Sets the minimum angle constraint for the joint at [code]joint_idx[/code]. - - + + Determines whether angle constraints on the CCDIK joint at [code]joint_idx[/code] are enabled. When [code]true[/code], constraints will be enabled and taken into account when solving. - - + + Sets whether the joint at [code]joint_idx[/code] is set to rotate from the joint, [code]true[/code], or to rotate from the tip, [code]false[/code]. diff --git a/doc/classes/SkeletonModification2DFABRIK.xml b/doc/classes/SkeletonModification2DFABRIK.xml index 883d4aa04b..3108a55deb 100644 --- a/doc/classes/SkeletonModification2DFABRIK.xml +++ b/doc/classes/SkeletonModification2DFABRIK.xml @@ -15,60 +15,60 @@ - + Returns the [Bone2D] node assigned to the FABRIK joint at [code]joint_idx[/code]. - + Returns the index of the [Bone2D] node assigned to the FABRIK joint at [code]joint_idx[/code]. - + Returns the magnet position vector for the joint at [code]joint_idx[/code]. - + Returns whether the joint is using the target's rotation rather than allowing FABRIK to rotate the joint. This option only applies to the tip/final joint in the chain. - - + + Sets the [Bone2D] node assigned to the FABRIK joint at [code]joint_idx[/code]. - - + + Sets the bone index, [code]bone_index[/code], of the FABRIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone2d_node[/code] of the FABRIK joint based on data provided by the linked skeleton. - - + + Sets the magnet position vector for the joint at [code]joint_idx[/code]. - - + + Sets whether the joint at [code]joint_idx[/code] will use the target node's rotation rather than letting FABRIK rotate the node. [b]Note:[/b] This option only works for the tip/final joint in the chain. For all other nodes, this option will be ignored. diff --git a/doc/classes/SkeletonModification2DJiggle.xml b/doc/classes/SkeletonModification2DJiggle.xml index 9948239eb8..0fadf6e6c2 100644 --- a/doc/classes/SkeletonModification2DJiggle.xml +++ b/doc/classes/SkeletonModification2DJiggle.xml @@ -19,56 +19,56 @@ - + Returns the [Bone2D] node assigned to the Jiggle joint at [code]joint_idx[/code]. - + Returns the index of the [Bone2D] node assigned to the Jiggle joint at [code]joint_idx[/code]. - + Returns the amount of damping of the Jiggle joint at [code]joint_idx[/code]. - + Returns a [Vector2] representing the amount of gravity the Jiggle joint at [code]joint_idx[/code] is influenced by. - + Returns the amount of mass of the jiggle joint at [code]joint_idx[/code]. - + Returns a boolean that indicates whether the joint at [code]joint_idx[/code] is overriding the default Jiggle joint data defined in the modification. - + Returns the stiffness of the Jiggle joint at [code]joint_idx[/code]. - + Returns a boolean that indicates whether the joint at [code]joint_idx[/code] is using gravity or not. @@ -81,78 +81,78 @@ - + Sets the collision mask that the Jiggle modifier will use when reacting to colliders, if the Jiggle modifier is set to take colliders into account. - - + + Sets the [Bone2D] node assigned to the Jiggle joint at [code]joint_idx[/code]. - - + + Sets the bone index, [code]bone_index[/code], of the Jiggle joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone2d_node[/code] of the Jiggle joint based on data provided by the linked skeleton. - - + + Sets the amount of dampening of the Jiggle joint at [code]joint_idx[/code]. - - + + Sets the gravity vector of the Jiggle joint at [code]joint_idx[/code]. - - + + Sets the of mass of the Jiggle joint at [code]joint_idx[/code]. - - + + Sets whether the Jiggle joint at [code]joint_idx[/code] should override the default Jiggle joint settings. Setting this to [code]true[/code] will make the joint use its own settings rather than the default ones attached to the modification. - - + + Sets the of stiffness of the Jiggle joint at [code]joint_idx[/code]. - - + + Sets whether the Jiggle joint at [code]joint_idx[/code] should use gravity. - + If [code]true[/code], the Jiggle modifier will take colliders into account, keeping them from entering into these collision objects. diff --git a/doc/classes/SkeletonModification2DLookAt.xml b/doc/classes/SkeletonModification2DLookAt.xml index 802801fbef..4747b06056 100644 --- a/doc/classes/SkeletonModification2DLookAt.xml +++ b/doc/classes/SkeletonModification2DLookAt.xml @@ -41,14 +41,14 @@ - + Sets the amount of additional rotation that is to be applied after executing the modification. This allows for offsetting the results by the inputted rotation amount. - + When [code]true[/code], the modification will use an inverted joint constraint. An inverted joint constraint only constraints the [Bone2D] to the angles [i]outside of[/i] the inputted minimum and maximum angles. For this reason, it is referred to as an inverted joint constraint, as it constraints the joint to the outside of the inputted values. @@ -56,21 +56,21 @@ - + Sets the constraint's maximum allowed angle. - + Sets the constraint's minimum allowed angle. - + Sets whether this modification will use constraints or not. When [code]true[/code], constraints will be applied when solving the LookAt modification. diff --git a/doc/classes/SkeletonModification2DPhysicalBones.xml b/doc/classes/SkeletonModification2DPhysicalBones.xml index 9fb7b6d215..9ddb34a5d0 100644 --- a/doc/classes/SkeletonModification2DPhysicalBones.xml +++ b/doc/classes/SkeletonModification2DPhysicalBones.xml @@ -17,15 +17,15 @@ - + Returns the [PhysicalBone2D] node at [code]joint_idx[/code]. - - + + Sets the [PhysicalBone2D] node at [code]joint_idx[/code]. [b]Note:[/b] This is just the index used for this modification, not the bone index used in the [Skeleton2D]. @@ -33,7 +33,7 @@ - + Tell the [PhysicalBone2D] nodes to start simulating and interacting with the physics world. Optionally, an array of bone names can be passed to this function, and that will cause only [PhysicalBone2D] nodes with those names to start simulating. @@ -41,7 +41,7 @@ - + Tell the [PhysicalBone2D] nodes to stop simulating and interacting with the physics world. Optionally, an array of bone names can be passed to this function, and that will cause only [PhysicalBone2D] nodes with those names to stop simulating. diff --git a/doc/classes/SkeletonModification2DStackHolder.xml b/doc/classes/SkeletonModification2DStackHolder.xml index f66f88d6b5..791dea2fb1 100644 --- a/doc/classes/SkeletonModification2DStackHolder.xml +++ b/doc/classes/SkeletonModification2DStackHolder.xml @@ -18,7 +18,7 @@ - + Sets the [SkeletonModificationStack2D] that this modification is holding. This modification stack will then be executed when this modification is executed. diff --git a/doc/classes/SkeletonModification2DTwoBoneIK.xml b/doc/classes/SkeletonModification2DTwoBoneIK.xml index 956e94dce8..edd5431a0c 100644 --- a/doc/classes/SkeletonModification2DTwoBoneIK.xml +++ b/doc/classes/SkeletonModification2DTwoBoneIK.xml @@ -36,28 +36,28 @@ - + Sets the [Bone2D] node that is being used as the first bone in the TwoBoneIK modification. - + Sets the index of the [Bone2D] node that is being used as the first bone in the TwoBoneIK modification. - + Sets the [Bone2D] node that is being used as the second bone in the TwoBoneIK modification. - + Sets the index of the [Bone2D] node that is being used as the second bone in the TwoBoneIK modification. diff --git a/doc/classes/SkeletonModification3D.xml b/doc/classes/SkeletonModification3D.xml index b21c9a2be9..9a6e72baaf 100644 --- a/doc/classes/SkeletonModification3D.xml +++ b/doc/classes/SkeletonModification3D.xml @@ -12,14 +12,14 @@ - + Executes the given modification. This is where the modification performs whatever function it is designed to do. - + Sets up the modification so it can be executed. This function should be called automatically by the [SkeletonModificationStack3D] containing this modification. If you need to initialize a modification before use, this is the place to do it! @@ -27,10 +27,10 @@ - - - - + + + + Takes a angle and clamps it so it is within the passed-in [code]min[/code] and [code]max[/code] range. [code]invert[/code] will inversely clamp the angle, clamping it to the range outside of the given bounds. @@ -49,7 +49,7 @@ - + Manually allows you to set the setup state of the modification. This function should only rarely be used, as the [SkeletonModificationStack3D] the modification is bound to should handle setting the modification up. diff --git a/doc/classes/SkeletonModification3DCCDIK.xml b/doc/classes/SkeletonModification3DCCDIK.xml index 6f5409ed4d..fbefca32ad 100644 --- a/doc/classes/SkeletonModification3DCCDIK.xml +++ b/doc/classes/SkeletonModification3DCCDIK.xml @@ -14,97 +14,97 @@ - + Returns the bone index of the bone assigned to the CCDIK joint at [code]joint_idx[/code]. - + Returns the name of the bone that is assigned to the CCDIK joint at [code]joint_idx[/code]. - + Returns the integer representing the joint axis of the CCDIK joint at [code]joint_idx[/code]. - + Returns the maximum angle constraint for the joint at [code]joint_idx[/code]. [b]Note:[/b] This angle is in degrees! - + Returns the minimum angle constraint for the joint at [code]joint_idx[/code]. [b]Note:[/b] This angle is in degrees! - + Returns whether the CCDIK joint at [code]joint_idx[/code] uses an inverted joint constraint. See [method set_ccdik_joint_constraint_invert] for details. - + Enables angle constraints to the CCDIK joint at [code]joint_idx[/code]. - - + + Sets the bone index, [code]bone_index[/code], of the CCDIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_name[/code] of the CCDIK joint based on data provided by the linked skeleton. - - + + Sets the bone name, [code]bone_name[/code], of the CCDIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_index[/code] of the CCDIK joint based on data provided by the linked skeleton. - - + + Sets the joint axis of the CCDIK joint at [code]joint_idx[/code] to the passed-in joint axis, [code]axis[/code]. - - + + Sets the maximum angle constraint for the joint at [code]joint_idx[/code]. [b]Note:[/b] This angle must be in radians! - - + + Sets the minimum angle constraint for the joint at [code]joint_idx[/code]. [b]Note:[/b] This angle must be in radians! - - + + Sets whether the CCDIK joint at [code]joint_idx[/code] uses an inverted joint constraint. An inverted joint constraint only constraints the CCDIK joint to the angles [i]outside of[/i] the inputted minimum and maximum angles. For this reason, it is referred to as an inverted joint constraint, as it constraints the joint to the outside of the inputted values. @@ -112,8 +112,8 @@ - - + + Sets whether joint constraints are enabled for the CCDIK joint at [code]joint_idx[/code]. diff --git a/doc/classes/SkeletonModification3DFABRIK.xml b/doc/classes/SkeletonModification3DFABRIK.xml index 41f78fab41..5908f94650 100644 --- a/doc/classes/SkeletonModification3DFABRIK.xml +++ b/doc/classes/SkeletonModification3DFABRIK.xml @@ -15,56 +15,56 @@ - + Will attempt to automatically calculate the length of the bone assigned to the FABRIK joint at [code]joint_idx[/code]. - + Returns a boolean that indicates whether this modification will attempt to autocalculate the length of the bone assigned to the FABRIK joint at [code]joint_idx[/code]. - + Returns the bone index of the bone assigned to the FABRIK joint at [code]joint_idx[/code]. - + Returns the name of the bone that is assigned to the FABRIK joint at [code]joint_idx[/code]. - + Returns the length of the FABRIK joint at [code]joint_idx[/code]. - + Returns the magnet vector of the FABRIK joint at [code]joint_idx[/code]. - + Returns the [Node3D]-based node placed at the tip of the FABRIK joint at [code]joint_idx[/code], if one has been set. - + Returns a boolean indicating whether the FABRIK joint uses the target's [Basis] for its rotation. [b]Note:[/b] This option is only available for the final bone in the FABRIK chain, with this setting being ignored for all other bones. @@ -72,55 +72,55 @@ - + Sets the [Node3D]-based node that will be used as the tip of the FABRIK joint at [code]joint_idx[/code]. - - + + When [code]true[/code], this modification will attempt to automatically calculate the length of the bone for the FABRIK joint at [code]joint_idx[/code]. It does this by either using the tip node assigned, if there is one assigned, or the distance the of the bone's children, if the bone has any. If the bone has no children and no tip node is assigned, then the modification [b]cannot[/b] autocalculate the joint's length. In this case, the joint length should be entered manually or a tip node assigned. - - + + Sets the bone index, [code]bone_index[/code], of the FABRIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_name[/code] of the FABRIK joint based on data provided by the [Skeleton3D]. - - + + Sets the bone name, [code]bone_name[/code], of the FABRIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_index[/code] of the FABRIK joint based on data provided by the [Skeleton3D]. - - + + Sets the joint length, [code]length[/code], of the FABRIK joint at [code]joint_idx[/code]. - - + + Sets the magenet position to [code]magnet_position[/code] for the joint at [code]joint_idx[/code]. The magnet position is used to nudge the joint in that direction when solving, which gives some control over how that joint will bend when being solved. - - + + Sets the nodepath of the FARIK joint at [code]joint_idx[/code] to [code]tip_node[/code]. The tip node is used to calculate the length of the FABRIK joint when set to automatically calculate joint length. [b]Note:[/b] The tip node should generally be a child node of a [BoneAttachment3D] node attached to the bone that this FABRIK joint operates on, with the child node being offset so it is at the end of the bone. @@ -128,8 +128,8 @@ - - + + Sets whether the FABRIK joint at [code]joint_idx[/code] uses the target's [Basis] for its rotation. [b]Note:[/b] This option is only available for the final bone in the FABRIK chain, with this setting being ignored for all other bones. @@ -137,8 +137,8 @@ - - + + Sets whether the tip node should be used when autocalculating the joint length for the FABRIK joint at [code]joint_idx[/code]. This will only work if there is a node assigned to the tip nodepath for this joint. diff --git a/doc/classes/SkeletonModification3DJiggle.xml b/doc/classes/SkeletonModification3DJiggle.xml index 697de4a580..ddbd5b4274 100644 --- a/doc/classes/SkeletonModification3DJiggle.xml +++ b/doc/classes/SkeletonModification3DJiggle.xml @@ -19,63 +19,63 @@ - + Returns the bone index of the bone assigned to the Jiggle joint at [code]joint_idx[/code]. - + Returns the name of the bone that is assigned to the Jiggle joint at [code]joint_idx[/code]. - + Returns the amount of dampening of the Jiggle joint at [code]joint_idx[/code]. - + Returns a [Vector3] representign the amount of gravity the Jiggle joint at [code]joint_idx[/code] is influenced by. - + Returns the amount of mass of the Jiggle joint at [code]joint_idx[/code]. - + Returns a boolean that indicates whether the joint at [code]joint_idx[/code] is overriding the default jiggle joint data defined in the modification. - + Returns the amount of roll/twist applied to the bone that the Jiggle joint is applied to. - + Returns the stiffness of the Jiggle joint at [code]joint_idx[/code]. - + Returns a boolean that indicates whether the joint at [code]joint_idx[/code] is using gravity or not. @@ -88,86 +88,86 @@ - + Sets the collision mask that the Jiggle modifier takes into account when performing physics calculations. - - + + Sets the bone index, [code]bone_index[/code], of the Jiggle joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_name[/code] of the Jiggle joint based on data provided by the [Skeleton3D]. - - + + Sets the bone name, [code]bone_name[/code], of the Jiggle joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_index[/code] of the Jiggle joint based on data provided by the [Skeleton3D]. - - + + Sets the amount of dampening of the Jiggle joint at [code]joint_idx[/code]. - - + + Sets the gravity vector of the Jiggle joint at [code]joint_idx[/code]. - - + + Sets the of mass of the Jiggle joint at [code]joint_idx[/code]. - - + + Sets whether the Jiggle joint at [code]joint_idx[/code] should override the default Jiggle joint settings. Setting this to true will make the joint use its own settings rather than the default ones attached to the modification. - - + + Sets the amount of roll/twist on the bone the Jiggle joint is attached to. - - + + Sets the of stiffness of the Jiggle joint at [code]joint_idx[/code]. - - + + Sets whether the Jiggle joint at [code]joint_idx[/code] should use gravity. - + When [code]true[/code], the Jiggle modifier will use raycasting to prevent the Jiggle joints from rotating themselves into collision objects when solving. diff --git a/doc/classes/SkeletonModification3DLookAt.xml b/doc/classes/SkeletonModification3DLookAt.xml index 90330c4cf0..3602cfad95 100644 --- a/doc/classes/SkeletonModification3DLookAt.xml +++ b/doc/classes/SkeletonModification3DLookAt.xml @@ -29,20 +29,20 @@ - + Sets the amount of extra rotation to be applied after the LookAt modification executes. This allows you to adjust the finished result. - + - + When [code]true[/code], the LookAt modification will limit its rotation to a single plane in 3D space. The plane used can be configured using the [code]set_lock_rotation_plane[/code] function. diff --git a/doc/classes/SkeletonModification3DStackHolder.xml b/doc/classes/SkeletonModification3DStackHolder.xml index d5ed770fc0..24240236a4 100644 --- a/doc/classes/SkeletonModification3DStackHolder.xml +++ b/doc/classes/SkeletonModification3DStackHolder.xml @@ -18,7 +18,7 @@ - + Sets the [SkeletonModificationStack3D] that this modification is holding. This modification stack will then be executed when this modification is executed. diff --git a/doc/classes/SkeletonModification3DTwoBoneIK.xml b/doc/classes/SkeletonModification3DTwoBoneIK.xml index 0576591e2e..2fd7afc360 100644 --- a/doc/classes/SkeletonModification3DTwoBoneIK.xml +++ b/doc/classes/SkeletonModification3DTwoBoneIK.xml @@ -91,7 +91,7 @@ - + If true, the TwoBoneIK modification will attempt to autocalculate the lengths of the bones being used. The first bone will be calculated by using the distance from the origin of the first bone to the origin of the second bone. The second bone will be calculated either using the tip node if that setting is enabled, or by using the distances of the second bone's children. If the tip node is not enabled and the bone has no children, then the length cannot be autocalculated. In this case, the length will either have to be manually inputted or a tip node used to calculate the length. @@ -99,70 +99,70 @@ - + Sets the bone index, [code]bone_index[/code], of the first bone. When possible, this will also update the [code]bone_name[/code] of the first bone based on data provided by the [Skeleton3D]. - + Sets the bone name, [code]bone_name[/code], of the first bone. When possible, this will also update the [code]bone_index[/code] of the first bone based on data provided by the [Skeleton3D]. - + Sets the length of the first bone in the TwoBoneIK modification. - + Sets the amount of roll/twist applied to the first bone in the TwoBoneIK modification. - + Sets the bone index, [code]bone_index[/code], of the second bone. When possible, this will also update the [code]bone_name[/code] of the second bone based on data provided by the [Skeleton3D]. - + Sets the bone name, [code]bone_name[/code], of the second bone. When possible, this will also update the [code]bone_index[/code] of the second bone based on data provided by the [Skeleton3D]. - + Sets the length of the second bone in the TwoBoneIK modification. - + Sets the amount of roll/twist applied to the second bone in the TwoBoneIK modification. - + Sets the node to be used as the for the pole of the TwoBoneIK. When a node is set and the modification is set to use the pole node, the TwoBoneIK modification will bend the nodes in the direction towards this node when the bones need to bend. - + Sets the node to be used as the tip for the second bone. This is used to calculate the length and position of the end of the second bone in the TwoBoneIK modification. [b]Note:[/b] The tip node should generally be a child node of a [BoneAttachment3D] node attached to the second bone, with the child node being offset so it is at the end of the bone. @@ -170,14 +170,14 @@ - + When [code]true[/code], the TwoBoneIK modification will bend the bones towards the pole node, if one has been set. This gives control over the direction the TwoBoneIK solver will bend, which is helpful for joints like elbows that only bend in certain directions. - + When [code]true[/code], the TwoBoneIK modification will use the tip node to calculate the distance and position of the end/tip of the second bone. This is the most stable solution for knowing the tip position and length of the second bone. diff --git a/doc/classes/SkeletonModificationStack2D.xml b/doc/classes/SkeletonModificationStack2D.xml index 9ddb8856ce..d752323231 100644 --- a/doc/classes/SkeletonModificationStack2D.xml +++ b/doc/classes/SkeletonModificationStack2D.xml @@ -13,29 +13,29 @@ - + Adds the passed-in [SkeletonModification2D] to the stack. - + Deletes the [SkeletonModification2D] at the index position [code]mod_idx[/code], if it exists. - + Enables all [SkeletonModification2D]s in the stack. - - + + Executes all of the [SkeletonModification2D]s in the stack that use the same execution mode as the passed-in [code]execution_mode[/code], starting from index [code]0[/code] to [member modification_count]. [b]Note:[/b] The order of the modifications can matter depending on the modifications. For example, modifications on a spine should operate before modifications on the arms in order to get proper results. @@ -49,7 +49,7 @@ - + Returns the [SkeletonModification2D] at the passed-in index, [code]mod_idx[/code]. @@ -62,8 +62,8 @@ - - + + Sets the modification at [code]mod_idx[/code] to the passed-in modification, [code]modification[/code]. diff --git a/doc/classes/SkeletonModificationStack3D.xml b/doc/classes/SkeletonModificationStack3D.xml index fc952f6864..010c2181e7 100644 --- a/doc/classes/SkeletonModificationStack3D.xml +++ b/doc/classes/SkeletonModificationStack3D.xml @@ -12,29 +12,29 @@ - + Adds the passed-in [SkeletonModification3D] to the stack. - + Deletes the [SkeletonModification3D] at the index position [code]mod_idx[/code], if it exists. - + Enables all [SkeletonModification3D]s in the stack. - - + + Executes all of the [SkeletonModification3D]s in the stack that use the same execution mode as the passed-in [code]execution_mode[/code], starting from index [code]0[/code] to [member modification_count]. [b]Note:[/b] The order of the modifications can matter depending on the modifications. For example, modifications on a spine should operate before modifications on the arms in order to get proper results. @@ -48,7 +48,7 @@ - + Returns the [SkeletonModification3D] at the passed-in index, [code]mod_idx[/code]. @@ -61,8 +61,8 @@ - - + + Sets the modification at [code]mod_idx[/code] to the passed-in modification, [code]modification[/code]. diff --git a/doc/classes/SkeletonProfile.xml b/doc/classes/SkeletonProfile.xml index 5c2d0eefb4..52925c2d41 100644 --- a/doc/classes/SkeletonProfile.xml +++ b/doc/classes/SkeletonProfile.xml @@ -11,14 +11,14 @@ - + Returns the bone index that matches [code]bone_name[/code] as its name. - + Returns the name of the bone at [code]bone_idx[/code] that will be the key name in the [BoneMap]. In the retargeting process, the returned bone name is the bone name of the target skeleton. @@ -26,35 +26,35 @@ - + Returns the name of the bone which is the parent to the bone at [code]bone_idx[/code]. The result is empty if the bone has no parent. - + Returns the name of the bone which is the tail of the bone at [code]bone_idx[/code]. - + Returns the group of the bone at [code]bone_idx[/code]. - + Returns the name of the group at [code]group_idx[/code] that will be the drawing group in the [BoneMap] editor. - + Returns the offset of the bone at [code]bone_idx[/code] that will be the button position in the [BoneMap] editor. This is the offset with origin at the top left corner of the square. @@ -62,29 +62,29 @@ - + Returns the reference pose transform for bone [code]bone_idx[/code]. - + Returns the tail direction of the bone at [code]bone_idx[/code]. - + Returns the texture of the group at [code]group_idx[/code] that will be the drawing group background image in the [BoneMap] editor. - - + + Sets the name of the bone at [code]bone_idx[/code] that will be the key name in the [BoneMap]. In the retargeting process, the setting bone name is the bone name of the target skeleton. @@ -92,40 +92,40 @@ - - + + Sets the bone with name [code]bone_parent[/code] as the parent of the bone at [code]bone_idx[/code]. If an empty string is passed, then the bone has no parent. - - + + Sets the bone with name [code]bone_tail[/code] as the tail of the bone at [code]bone_idx[/code]. - - + + Sets the group of the bone at [code]bone_idx[/code]. - - + + Sets the name of the group at [code]group_idx[/code] that will be the drawing group in the [BoneMap] editor. - - + + Sets the offset of the bone at [code]bone_idx[/code] that will be the button position in the [BoneMap] editor. This is the offset with origin at the top left corner of the square. @@ -133,16 +133,16 @@ - - + + Sets the reference pose transform for bone [code]bone_idx[/code]. - - + + Sets the tail direction of the bone at [code]bone_idx[/code]. [b]Note:[/b] This only specifies the method of calculation. The actual coordinates required should be stored in an external skeleton, so the calculation itself needs to be done externally. @@ -150,8 +150,8 @@ - - + + Sets the texture of the group at [code]group_idx[/code] that will be the drawing group background image in the [BoneMap] editor. diff --git a/doc/classes/Skin.xml b/doc/classes/Skin.xml index af1af7bad2..ea60bd707d 100644 --- a/doc/classes/Skin.xml +++ b/doc/classes/Skin.xml @@ -9,15 +9,15 @@ - - + + - - + + @@ -28,7 +28,7 @@ - + @@ -39,40 +39,40 @@ - + - + - - + + - + - - + + - - + + diff --git a/doc/classes/Slider.xml b/doc/classes/Slider.xml index 4139530db1..88ea7f2b49 100644 --- a/doc/classes/Slider.xml +++ b/doc/classes/Slider.xml @@ -25,7 +25,7 @@ - + Emitted when dragging stops. If [code]value_changed[/code] is true, [member Range.value] is different from the value when you started the dragging. diff --git a/doc/classes/SliderJoint3D.xml b/doc/classes/SliderJoint3D.xml index d62cf8aac4..7470f89979 100644 --- a/doc/classes/SliderJoint3D.xml +++ b/doc/classes/SliderJoint3D.xml @@ -11,14 +11,14 @@ - + - - + + diff --git a/doc/classes/SoftDynamicBody3D.xml b/doc/classes/SoftDynamicBody3D.xml index 86552f30f6..f59df90eca 100644 --- a/doc/classes/SoftDynamicBody3D.xml +++ b/doc/classes/SoftDynamicBody3D.xml @@ -13,7 +13,7 @@ - + Adds a body to the list of bodies that this body can't collide with. @@ -26,14 +26,14 @@ - + Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [code]layer_number[/code] between 1 and 32. - + Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. @@ -45,46 +45,46 @@ - + Returns local translation of a vertex in the surface array. - + Returns [code]true[/code] if vertex is set to pinned. - + Removes a body from the list of bodies that this body can't collide with. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member collision_layer], given a [code]layer_number[/code] between 1 and 32. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. - - - + + + Sets the pinned state of a surface vertex. When set to [code]true[/code], the optional [code]attachment_path[/code] can define a [Node3D] the pinned vertex will be attached to. diff --git a/doc/classes/SplitContainer.xml b/doc/classes/SplitContainer.xml index f2bc65f8df..fb4b9466b5 100644 --- a/doc/classes/SplitContainer.xml +++ b/doc/classes/SplitContainer.xml @@ -30,7 +30,7 @@ - + Emitted when the dragger is dragged by user. diff --git a/doc/classes/SpringArm3D.xml b/doc/classes/SpringArm3D.xml index d89b8f4549..29331e3071 100644 --- a/doc/classes/SpringArm3D.xml +++ b/doc/classes/SpringArm3D.xml @@ -14,7 +14,7 @@ - + Adds the [PhysicsBody3D] object with the given [RID] to the list of [PhysicsBody3D] objects excluded from the collision check. @@ -33,7 +33,7 @@ - + Removes the given [RID] from the list of [PhysicsBody3D] objects excluded from the collision check. diff --git a/doc/classes/Sprite2D.xml b/doc/classes/Sprite2D.xml index 2edc13a12b..83532721b2 100644 --- a/doc/classes/Sprite2D.xml +++ b/doc/classes/Sprite2D.xml @@ -41,7 +41,7 @@ - + Returns [code]true[/code], if the pixel at the given position is opaque and [code]false[/code] in other case. [b]Note:[/b] It also returns [code]false[/code], if the sprite's texture is [code]null[/code] or if the given position is invalid. diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index bc381578d9..5fa984e7a0 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -17,7 +17,7 @@ - + Returns the value of the specified flag. @@ -30,8 +30,8 @@ - - + + If [code]true[/code], the specified flag will be enabled. See [enum SpriteBase3D.DrawFlags] for a list of flags. diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index 0d423630d4..f063a4c4c2 100644 --- a/doc/classes/SpriteFrames.xml +++ b/doc/classes/SpriteFrames.xml @@ -12,23 +12,23 @@ - + Adds a new animation to the library. - - - + + + Adds a frame to the given animation. - + Removes all frames from the given animation. @@ -41,7 +41,7 @@ - + Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code]. @@ -54,77 +54,77 @@ - + The animation's speed in frames per second. - - + + Returns the animation's selected frame. - + Returns the number of frames in the animation. - + If [code]true[/code], the named animation exists. - + Removes the given animation. - - + + Removes the animation's selected frame. - - + + Changes the animation's name to [code]newname[/code]. - - + + If [code]true[/code], the animation will loop. - - + + The animation's speed in frames per second. - - - + + + Sets the texture of the given frame. diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index bd69867001..7ce38d9d21 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -42,7 +42,7 @@ - + Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the [code]bytes[/code] argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an [enum @GlobalScope.Error] code and a data array. @@ -61,14 +61,14 @@ - + Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [enum @GlobalScope.Error] code, and a data array. - + Gets an ASCII string with byte-length [code]bytes[/code] from the stream. If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_string]. @@ -99,14 +99,14 @@ - + Gets an UTF-8 string with byte-length [code]bytes[/code] from the stream (this decodes the string sent as UTF-8). If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_utf8_string]. - + Gets a Variant from the stream. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. @@ -114,63 +114,63 @@ - + Puts a signed 16-bit value into the stream. - + Puts a signed 32-bit value into the stream. - + Puts a signed 64-bit value into the stream. - + Puts a signed byte into the stream. - + 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. - + Puts a double-precision float into the stream. - + Puts a single-precision float into the stream. - + 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. - + Puts a zero-terminated ASCII string into the stream prepended by a 32-bit unsigned integer representing its size. [b]Note:[/b] To put an ASCII string without prepending its size, you can use [method put_data]: @@ -186,35 +186,35 @@ - + Puts an unsigned 16-bit value into the stream. - + Puts an unsigned 32-bit value into the stream. - + Puts an unsigned 64-bit value into the stream. - + Puts an unsigned byte into the stream. - + Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsigned integer representing its size. [b]Note:[/b] To put an UTF-8 string without prepending its size, you can use [method put_data]: @@ -230,8 +230,8 @@ - - + + Puts a Variant into the stream. If [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). diff --git a/doc/classes/StreamPeerBuffer.xml b/doc/classes/StreamPeerBuffer.xml index de725aef5b..ee603360fa 100644 --- a/doc/classes/StreamPeerBuffer.xml +++ b/doc/classes/StreamPeerBuffer.xml @@ -36,14 +36,14 @@ - + Resizes the [member data_array]. This [i]doesn't[/i] update the cursor. - + Moves the cursor to the specified position. [code]position[/code] must be a valid index of [member data_array]. diff --git a/doc/classes/StreamPeerExtension.xml b/doc/classes/StreamPeerExtension.xml index a3a08c530c..46783de275 100644 --- a/doc/classes/StreamPeerExtension.xml +++ b/doc/classes/StreamPeerExtension.xml @@ -14,33 +14,33 @@ - - - + + + - - - + + + - - - + + + - - - + + + diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 70762cbf6c..dd571226b8 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -13,20 +13,20 @@ - - - - + + + + Accepts a peer connection as a server using the given [code]private_key[/code] and providing the given [code]certificate[/code] to the client. You can pass the optional [code]chain[/code] parameter to provide additional CA chain information along with the certificate. - - - - + + + + Connects to a peer using an underlying [StreamPeer] [code]stream[/code]. If [code]validate_certs[/code] is [code]true[/code], [StreamPeerSSL] will validate that the certificate presented by the peer matches the [code]for_hostname[/code]. [b]Note:[/b] Specifying a custom [code]valid_certificate[/code] is not supported in HTML5 exports due to browsers restrictions. diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index f06cf5c7a2..58f3a0e8db 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -12,8 +12,8 @@ - - + + Opens the TCP socket, and binds it to the specified local address. This method is generally not needed, and only used to force the subsequent call to [method connect_to_host] to use the specified [code]host[/code] and [code]port[/code] as source address. This can be desired in some NAT punchthrough techniques, or when forcing the source network interface. @@ -21,8 +21,8 @@ - - + + Connects to the specified [code]host:port[/code] pair. A hostname will be resolved if valid. Returns [constant OK] on success. @@ -65,7 +65,7 @@ - + If [code]enabled[/code] is [code]true[/code], packets will be sent immediately. If [code]enabled[/code] is [code]false[/code] (the default), packet transfers will be delayed and combined using [url=https://en.wikipedia.org/wiki/Nagle%27s_algorithm]Nagle's algorithm[/url]. [b]Note:[/b] It's recommended to leave this disabled for applications that send large packets or need to transfer a lot of data, as enabling this can decrease the total available bandwidth. diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 35ad5f03ab..06579ec49e 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -18,21 +18,21 @@ - + Constructs a [String] as a copy of the given [String]. - + Constructs a new String from the given [NodePath]. - + Constructs a new String from the given [StringName]. @@ -41,7 +41,7 @@ - + Returns [code]true[/code] if the string begins with the given string. @@ -92,7 +92,7 @@ - + Performs a case-sensitive comparison to another string. Returns [code]-1[/code] if less than, [code]1[/code] if greater than, or [code]0[/code] if equal. "less than" or "greater than" are determined by the [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode code points[/url] of each string, which roughly matches the alphabetical order. [b]Behavior with different string lengths:[/b] Returns [code]1[/code] if the "base" string is longer than the [code]to[/code] string or [code]-1[/code] if the "base" string is shorter than the [code]to[/code] string. Keep in mind this length is determined by the number of Unicode codepoints, [i]not[/i] the actual visible characters. @@ -102,7 +102,7 @@ - + Directly converts an decimal integer to a unicode character. Tables of these characters can be found in various locations, for example [url=https://unicodelookup.com/]here.[/url] [codeblock] @@ -113,25 +113,25 @@ - + Returns [code]true[/code] if the string contains the given string. - - - + + + Returns the number of occurrences of substring [code]what[/code] between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used. - - - + + + Returns the number of occurrences of substring [code]what[/code] (ignoring case) between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used. @@ -144,15 +144,15 @@ - + Returns [code]true[/code] if the string ends with the given string. - - + + Returns the index of the [b]first[/b] case-sensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the end of the string. [b]Note:[/b] If you just want to know whether a string contains a substring, use the [code]in[/code] operator as follows: @@ -169,16 +169,16 @@ - - + + Returns the index of the [b]first[/b] case-insensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the end of the string. - - + + Formats the string by replacing all occurrences of [code]placeholder[/code] with the elements of [code]values[/code]. [code]values[/code] can be a [Dictionary] or an [Array]. Any underscores in [code]placeholder[/code] will be replaced with the corresponding keys in advance. Array elements use their index as keys. @@ -234,8 +234,8 @@ - - + + Splits a string using a [code]delimiter[/code] and returns a substring at index [code]slice[/code]. Returns an empty string if the index doesn't exist. This is a more performant alternative to [method split] for cases when you need only one element from the array at a fixed index. @@ -247,15 +247,15 @@ - + Splits a string using a [code]delimiter[/code] and returns a number of slices. - - + + Splits a string using a Unicode character with code [code]delimiter[/code] and returns a substring at index [code]slice[/code]. Returns an empty string if the index doesn't exist. This is a more performant alternative to [method split] for cases when you need only one element from the array at a fixed index. @@ -286,7 +286,7 @@ - + Converts an integer representing a number of bytes into a human-readable form. Note that this output is in [url=https://en.wikipedia.org/wiki/Binary_prefix#IEC_prefixes]IEC prefix format[/url], and includes [code]B[/code], [code]KiB[/code], [code]MiB[/code], [code]GiB[/code], [code]TiB[/code], [code]PiB[/code], and [code]EiB[/code]. @@ -294,7 +294,7 @@ - + Returns a copy of the string with lines indented with [code]prefix[/code]. For example, the string can be indented with two tabs using [code]"\t\t"[/code], or four spaces using [code]" "[/code]. The prefix can be any string so it can also be used to comment out strings with e.g. [code]"# "[/code]. See also [method dedent] to remove indentation. @@ -303,8 +303,8 @@ - - + + Returns a copy of the string with the substring [code]what[/code] inserted at the given position. @@ -329,14 +329,14 @@ - + Returns [code]true[/code] if this string is a subsequence of the given string. - + Returns [code]true[/code] if this string is a subsequence of the given string, without considering case. @@ -362,7 +362,7 @@ - + Returns [code]true[/code] if this string contains a valid hexadecimal number. If [code]with_prefix[/code] is [code]true[/code], then a validity of the hexadecimal number is determined by [code]0x[/code] prefix, for instance: [code]0xDEADC0DE[/code]. @@ -405,7 +405,7 @@ - + Returns a [String] which is the concatenation of the [code]parts[/code]. The separator between elements is the string providing this method. Example: @@ -427,7 +427,7 @@ - + Returns a number of characters from the left of the string. If negative [code]length[/code] is used, the characters are counted downwards from [String]'s length. Examples: @@ -445,15 +445,15 @@ - - + + Formats a string to be at least [code]min_length[/code] long by adding [code]character[/code]s to the left of the string. - + Returns a copy of the string with characters removed from the left. The [code]chars[/code] argument is a string specifying the set of characters to be removed. [b]Note:[/b] The [code]chars[/code] is not a prefix. See [method trim_prefix] method that will remove a single prefix string rather than a set of characters. @@ -461,14 +461,14 @@ - + Does a simple case-sensitive expression match, where [code]"*"[/code] matches zero or more arbitrary characters and [code]"?"[/code] matches any single character except a period ([code]"."[/code]). An empty string or empty expression always evaluates to [code]false[/code]. - + Does a simple case-insensitive expression match, where [code]"*"[/code] matches zero or more arbitrary characters and [code]"?"[/code] matches any single character except a period ([code]"."[/code]). An empty string or empty expression always evaluates to [code]false[/code]. @@ -487,7 +487,7 @@ - + Performs a case-insensitive [i]natural order[/i] comparison to another string. Returns [code]-1[/code] if less than, [code]1[/code] if greater than, or [code]0[/code] if equal. "less than" or "greater than" are determined by the [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode code points[/url] of each string, which roughly matches the alphabetical order. Internally, lowercase characters will be converted to uppercase during the comparison. When used for sorting, natural order comparison will order suites of numbers as expected by most people. If you sort the numbers from 1 to 10 using natural order, you will get [code][1, 2, 3, ...][/code] instead of [code][1, 10, 2, 3, ...][/code]. @@ -498,7 +498,7 @@ - + Performs a case-insensitive comparison to another string. Returns [code]-1[/code] if less than, [code]1[/code] if greater than, or [code]0[/code] if equal. "less than" or "greater than" are determined by the [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode code points[/url] of each string, which roughly matches the alphabetical order. Internally, lowercase characters will be converted to uppercase during the comparison. [b]Behavior with different string lengths:[/b] Returns [code]1[/code] if the "base" string is longer than the [code]to[/code] string or [code]-1[/code] if the "base" string is shorter than the [code]to[/code] string. Keep in mind this length is determined by the number of Unicode codepoints, [i]not[/i] the actual visible characters. @@ -508,8 +508,8 @@ - - + + Converts a [float] to a string representation of a decimal number. The number of decimal places can be specified with [code]decimals[/code]. If [code]decimals[/code] is [code]-1[/code] (default), decimal places will be automatically adjusted so that the string representation has 14 significant digits (counting both digits to the left and the right of the decimal point). @@ -530,91 +530,91 @@ - - - + + + Converts a signed [int] to a string representation of a number. - + - - - + + + Converts a unsigned [int] to a string representation of a number. - + Formats a number to have an exact number of [code]digits[/code] after the decimal point. - + Formats a number to have an exact number of [code]digits[/code] before the decimal point. - + If the string is a path, this concatenates [code]file[/code] at the end of the string as a subpath. E.g. [code]"this/is".plus_file("path") == "this/is/path"[/code]. - + Returns original string repeated a number of times. The number of repetitions is given by the argument. - - + + Replaces occurrences of a case-sensitive substring with the given one inside the string. - - + + Replaces occurrences of a case-insensitive substring with the given one inside the string. - - + + Returns the index of the [b]last[/b] case-sensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the beginning of the string. - - + + Returns the index of the [b]last[/b] case-insensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the beginning of the string. - + Returns a number of characters from the right of the string. If negative [code]length[/code] is used, the characters are counted downwards from [String]'s length. Examples: @@ -626,17 +626,17 @@ - - + + Formats a string to be at least [code]min_length[/code] long by adding [code]character[/code]s to the right of the string. - - - + + + Splits the string by a [code]delimiter[/code] string and returns an array of the substrings, starting from right. The splits in the returned array are sorted in the same order as the original string, from left to right. @@ -659,7 +659,7 @@ - + Returns a copy of the string with characters removed from the right. The [code]chars[/code] argument is a string specifying the set of characters to be removed. [b]Note:[/b] The [code]chars[/code] is not a suffix. See [method trim_suffix] method that will remove a single suffix string rather than a set of characters. @@ -691,7 +691,7 @@ - + Returns the similarity index ([url=https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient]Sorensen-Dice coefficient[/url]) of this string compared to another. A result of 1.0 means totally similar, while 0.0 means totally dissimilar. [codeblock] @@ -710,9 +710,9 @@ - - - + + + Splits the string by a [code]delimiter[/code] string and returns an array of the substrings. The [code]delimiter[/code] can be of any length. If [code]allow_empty[/code] is [code]true[/code], and there are two adjacent delimiters in the string, it will add an empty string to the array of substrings at this position. @@ -739,8 +739,8 @@ - - + + Splits the string in floats by using a delimiter string and returns an array of the substrings. For example, [code]"1,2.5,3"[/code] will return [code][1,2.5,3][/code] if split by [code]","[/code]. @@ -749,8 +749,8 @@ - - + + Returns a copy of the string stripped of any non-printable character (including tabulations, spaces and line breaks) at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. @@ -763,8 +763,8 @@ - - + + Returns part of the string from the position [code]from[/code] with length [code]len[/code]. Argument [code]len[/code] is optional and using [code]-1[/code] will return remaining characters from given position. @@ -830,21 +830,21 @@ - + Removes a given string from the start if it starts with it or leaves the string unchanged. - + Removes a given string from the end if it ends with it or leaves the string unchanged. - + Returns the character code at position [code]at[/code]. @@ -885,7 +885,7 @@ - + Returns a copy of the string with special characters escaped using the XML standard. If [code]escape_quotes[/code] is [code]true[/code], the single quote ([code]'[/code]) and double quote ([code]"[/code]) characters are also escaped. @@ -900,73 +900,73 @@ - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml index a2bcac9788..c40d8929fc 100644 --- a/doc/classes/StringName.xml +++ b/doc/classes/StringName.xml @@ -19,14 +19,14 @@ - + Constructs a [StringName] as a copy of the given [StringName]. - + Creates a new [StringName] from the given [String]. [code]StringName("example")[/code] is equivalent to [code]&"example"[/code]. @@ -43,49 +43,49 @@ - + - + - + - + - + - + - + - + diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml index d863e3c652..8593acd1ef 100644 --- a/doc/classes/StyleBox.xml +++ b/doc/classes/StyleBox.xml @@ -12,8 +12,8 @@ - - + + @@ -24,27 +24,27 @@ - + - + - - + + - - + + Draws this stylebox using a canvas item identified by the given [RID]. The [RID] value can either be the result of [method CanvasItem.get_canvas_item] called on an existing [CanvasItem]-derived node, or directly from creating a canvas item in the [RenderingServer] with [method RenderingServer.canvas_item_create]. @@ -64,14 +64,14 @@ - + Returns the default margin of the specified [enum Side]. - + Returns the content margin offset for the specified [enum Side]. Positive values reduce size inwards, unlike [Control]'s margin values. @@ -91,16 +91,16 @@ - - + + Sets the default value of the specified [enum Side] to [code]offset[/code] pixels. - - + + Test a position in a rectangle, return whether it passes the mask test. diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index c80f8dcbb1..48f656af8e 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -26,7 +26,7 @@ - + Returns the specified [enum Side]'s border width. @@ -39,79 +39,79 @@ - + Returns the given [code]corner[/code]'s radius. See [enum Corner] for possible values. - + Returns the size of the specified [enum Side]'s expand margin. - - + + Sets the specified [enum Side]'s border width to [code]width[/code] pixels. - + Sets the border width to [code]width[/code] pixels for all sides. - - + + Sets the corner radius to [code]radius[/code] pixels for the given [code]corner[/code]. See [enum Corner] for possible values. - + Sets the corner radius to [code]radius[/code] pixels for all corners. - - - - + + + + Sets the corner radius for each corner to [code]radius_top_left[/code], [code]radius_top_right[/code], [code]radius_bottom_right[/code], and [code]radius_bottom_left[/code] pixels. - - + + Sets the expand margin to [code]size[/code] pixels for the specified [enum Side]. - + Sets the expand margin to [code]size[/code] pixels for all margins. - - - - + + + + Sets the expand margin for each margin to [code]size_left[/code], [code]size_top[/code], [code]size_right[/code], and [code]size_bottom[/code] pixels. diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml index 8c324d4e37..2468857cf1 100644 --- a/doc/classes/StyleBoxTexture.xml +++ b/doc/classes/StyleBoxTexture.xml @@ -11,47 +11,47 @@ - + Returns the expand margin size of the specified [enum Side]. - + Returns the margin size of the specified [enum Side]. - + Sets the expand margin to [code]size[/code] pixels for all margins. - - - - + + + + Sets the expand margin for each margin to [code]size_left[/code], [code]size_top[/code], [code]size_right[/code], and [code]size_bottom[/code] pixels. - - + + Sets the expand margin to [code]size[/code] pixels for the specified [enum Side]. - - + + Sets the margin to [code]size[/code] pixels for the specified [enum Side]. diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index ad638a680b..51c9e59fd2 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -33,19 +33,19 @@ - + Adds a vertex to index array if you are using indexed vertices. Does not need to be called before adding vertices. - - - - - - + + + + + + Inserts a triangle fan made of array data into [Mesh] being constructed. Requires the primitive type be set to [constant Mesh.PRIMITIVE_TRIANGLES]. @@ -53,23 +53,23 @@ - + Specifies the position of current vertex. Should be called after specifying other vertex properties (e.g. Color, UV). - - - + + + Append vertices from a given [Mesh] surface onto the current vertex array with specified [Transform3D]. - + Called before adding any vertices. Takes the primitive type as an argument (e.g. [constant Mesh.PRIMITIVE_TRIANGLES]). @@ -82,8 +82,8 @@ - - + + Returns a constructed [ArrayMesh] from current information passed in. If an existing [ArrayMesh] is passed in as an argument, will add an extra surface to the existing [ArrayMesh]. [b]FIXME:[/b] Document possible values for [code]flags[/code], it changed in 4.0. Likely some combinations of [enum Mesh.ArrayFormat]. @@ -97,17 +97,17 @@ - - + + Creates a vertex array from an existing [Mesh]. - - - + + + Creates a vertex array from the specified blend shape of an existing [Mesh]. This can be used to extract a specific pose from a blend shape. @@ -120,8 +120,8 @@ - - + + Generates a LOD for a given [code]nd_threshold[/code] in linear units (square root of quadric error metric), using at most [code]target_index_count[/code] indices. Deprecated. Unused internally and neglects to preserve normals or UVs. Consider using [method ImporterMesh.generate_lods] instead. @@ -129,7 +129,7 @@ - + Generates normals from vertices so you do not have to do it manually. If [code]flip[/code] is [code]true[/code], the resulting normals will be inverted. [method generate_normals] should be called [i]after[/i] generating geometry and [i]before[/i] committing the mesh using [method commit] or [method commit_to_arrays]. For correct display of normal-mapped surfaces, you will also have to generate tangents using [method generate_tangents]. [b]Note:[/b] [method generate_normals] only works if the primitive type to be set to [constant Mesh.PRIMITIVE_TRIANGLES]. @@ -149,7 +149,7 @@ - + Returns the format for custom [code]channel_index[/code] (currently up to 4). Returns [constant CUSTOM_MAX] if this custom channel is unused. @@ -182,14 +182,14 @@ - + Specifies an array of bones to use for the [i]next[/i] vertex. [code]bones[/code] must contain 4 integers. - + Specifies a [Color] to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. [b]Note:[/b] The material must have [member BaseMaterial3D.vertex_color_use_as_albedo] enabled for the vertex color to be visible. @@ -197,8 +197,8 @@ - - + + Sets the custom value on this vertex for [code]channel_index[/code]. [method set_custom_format] must be called first for this [code]channel_index[/code]. Formats which are not RGBA will ignore other color channels. @@ -206,8 +206,8 @@ - - + + Sets the color format for this custom [code]channel_index[/code]. Use [constant CUSTOM_MAX] to disable. Must be invoked after [method begin] and should be set before [method commit] or [method commit_to_arrays]. @@ -215,21 +215,21 @@ - + Sets [Material] to be used by the [Mesh] you are constructing. - + Specifies a normal to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. - + Set to [constant SKIN_8_WEIGHTS] to indicate that up to 8 bone influences per vertex may be used. By default, only 4 bone influences are used ([constant SKIN_4_WEIGHTS]) @@ -238,35 +238,35 @@ - + Specifies whether the current vertex (if using only vertex arrays) or current index (if also using index arrays) should use smooth normals for normal calculation. - + Specifies a tangent to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. - + Specifies a set of UV coordinates to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. - + Specifies an optional second set of UV coordinates to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. - + Specifies weight values to use for the [i]next[/i] vertex. [code]weights[/code] must contain 4 values. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. diff --git a/doc/classes/SyntaxHighlighter.xml b/doc/classes/SyntaxHighlighter.xml index 70cbd83371..fcac96c04d 100644 --- a/doc/classes/SyntaxHighlighter.xml +++ b/doc/classes/SyntaxHighlighter.xml @@ -19,7 +19,7 @@ - + Virtual method which can be overridden to return syntax highlighting data. See [method get_line_syntax_highlighting] for more details. @@ -40,7 +40,7 @@ - + Returns syntax highlighting data for a single line. If the line is not cached, calls [method _get_line_syntax_highlighting] to calculate the data. The return [Dictionary] is column number to [Dictionary]. The column number notes the start of a region, the region will end if another region is found, or at the end of the line. The nested [Dictionary] contains the data for that region, currently only the key "color" is supported. diff --git a/doc/classes/TCPServer.xml b/doc/classes/TCPServer.xml index 06fe4de9e2..0990fb853a 100644 --- a/doc/classes/TCPServer.xml +++ b/doc/classes/TCPServer.xml @@ -30,8 +30,8 @@ - - + + Listen on the [code]port[/code] binding to [code]bind_address[/code]. If [code]bind_address[/code] is set as [code]"*"[/code] (default), the server will listen on all available addresses (both IPv4 and IPv6). diff --git a/doc/classes/TabBar.xml b/doc/classes/TabBar.xml index 79d52b70fb..f4ec33e9e1 100644 --- a/doc/classes/TabBar.xml +++ b/doc/classes/TabBar.xml @@ -11,15 +11,15 @@ - - + + Adds a new tab. - + Moves the scroll view to make the tab visible. @@ -38,28 +38,28 @@ - + Returns the [Texture2D] for the right button of the tab at index [code]tab_idx[/code] or [code]null[/code] if the button has no [Texture2D]. - + Returns the [Texture2D] for the tab at index [code]tab_idx[/code] or [code]null[/code] if the tab has no [Texture2D]. - + Returns the index of the tab at local coordinates [code]point[/code]. Returns [code]-1[/code] if the point is outside the control boundaries or if there's no tab at the queried position. - + Returns tab title language code. @@ -72,106 +72,106 @@ - + Returns tab [Rect2] with local position and size. - + Returns tab title text base writing direction. - + Returns the title of the tab at index [code]tab_idx[/code]. - + Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled. - + Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is hidden. - - + + Moves a tab from [code]from[/code] to [code]to[/code]. - + Removes the tab at index [code]tab_idx[/code]. - - + + Sets an [code]icon[/code] for the button of the tab at index [code]tab_idx[/code] (located to the right, before the close button), making it visible and clickable (See [signal tab_button_pressed]). Giving it a [code]null[/code] value will hide the button. - - + + If [code]disabled[/code] is [code]true[/code], disables the tab at index [code]tab_idx[/code], making it non-interactable. - - + + If [code]hidden[/code] is [code]true[/code], hides the tab at index [code]tab_idx[/code], making it disappear from the tab area. - - + + Sets an [code]icon[/code] for the tab at index [code]tab_idx[/code]. - - + + Sets language code of tab title used for line-breaking and text shaping algorithms, if left empty current locale is used instead. - - + + Sets tab title base writing direction. - - + + Sets a [code]title[/code] for the tab at index [code]tab_idx[/code]. @@ -215,31 +215,31 @@ - + Emitted when the active tab is rearranged via mouse drag. See [member drag_to_rearrange_enabled]. - + Emitted when a tab's right button is pressed. See [method set_tab_button_icon]. - + Emitted when switching to another tab. - + Emitted when a tab is clicked, even if it is the current tab. - + Emitted when a tab's close button is pressed. [b]Note:[/b] Tabs are not removed automatically once the close button is pressed, this behavior needs to be programmed manually. For example: @@ -254,19 +254,19 @@ - + Emitted when a tab is hovered by the mouse. - + Emitted when a tab is right-clicked. [member select_with_rmb] must be enabled. - + Emitted when a tab is selected via click or script, even if it is the current tab. diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 10b5f730ad..3a3b0a7b28 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -33,14 +33,14 @@ - + Returns the button icon from the tab at index [code]tab_idx[/code]. - + Returns the [Control] node from the tab at index [code]tab_idx[/code]. @@ -53,89 +53,89 @@ - + Returns the [Texture2D] for the tab at index [code]tab_idx[/code] or [code]null[/code] if the tab has no [Texture2D]. - + Returns the index of the tab at local coordinates [code]point[/code]. Returns [code]-1[/code] if the point is outside the control boundaries or if there's no tab at the queried position. - + Returns the index of the tab tied to the given [code]control[/code]. The control must be a child of the [TabContainer]. - + Returns the title of the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title]. - + Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled. - + Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is hidden. - + If set on a [Popup] node instance, a popup menu icon appears in the top-right corner of the [TabContainer] (setting it to [code]null[/code] will make it go away). Clicking it will expand the [Popup] node. - - + + Sets the button icon from the tab at index [code]tab_idx[/code]. - - + + If [code]disabled[/code] is [code]true[/code], disables the tab at index [code]tab_idx[/code], making it non-interactable. - - + + If [code]hidden[/code] is [code]true[/code], hides the tab at index [code]tab_idx[/code], making it disappear from the tab area. - - + + Sets an icon for the tab at index [code]tab_idx[/code]. - - + + Sets a custom title for the tab at index [code]tab_idx[/code] (tab titles default to the name of the indexed child node). Set it back to the child's name to make the tab default to it again. @@ -175,19 +175,19 @@ - + Emitted when the user clicks on the button icon on this tab. - + Emitted when switching to another tab. - + Emitted when a tab is selected, even if it is the current tab. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 18a4893f03..c1fdfbf085 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -30,7 +30,7 @@ - + Override this method to define what happens when the types in the provided key [code]unicode[/code]. @@ -50,7 +50,7 @@ - + Register a new gutter to this [TextEdit]. Use [code]at[/code] to have a specific gutter order. A value of [code]-1[/code] appends the gutter to the right. @@ -147,7 +147,7 @@ - + Returns the first column containing a non-whitespace character. @@ -166,28 +166,28 @@ - + Returns the name of the gutter at the given index. - + Returns the type of the gutter at the given index. - + Returns the width of the gutter at the given index. - + Returns the amount of spaces and [code]tab * tab_size[/code] before the first char. @@ -212,22 +212,22 @@ - + Returns the text of a specific line. - + Returns the current background color of the line. [code]Color(0, 0, 0, 0)[/code] is returned if no color is set. - - + + Returns the line and column at the given position. In the returned vector, [code]x[/code] is the column, [code]y[/code] is the line. If [code]allow_out_of_bounds[/code] is [code]false[/code] and the position is not over the text, both vector values will be set to [code]-1[/code]. @@ -240,32 +240,32 @@ - - + + Returns the icon currently in [code]gutter[/code] at [code]line[/code]. - - + + Returns the color currently in [code]gutter[/code] at [code]line[/code]. - - + + Returns the metadata currently in [code]gutter[/code] at [code]line[/code]. - - + + Returns the text currently in [code]gutter[/code] at [code]line[/code]. @@ -278,30 +278,30 @@ - - + + Returns the width in pixels of the [code]wrap_index[/code] on [code]line[/code]. - + Returns the number of times the given line is wrapped. - - + + Returns the wrap index of the given line column. - + Returns an array of [String]s representing each wrapped index. @@ -321,7 +321,7 @@ - + Returns the equivalent minimap line at [code]position[/code] @@ -334,25 +334,25 @@ - - - + + + Similar to [method get_next_visible_line_offset_from], but takes into account the line wrap indexes. In the returned vector, [code]x[/code] is the line, [code]y[/code] is the wrap index. - - + + Returns the count to the next visible line from [code]line[/code] to [code]line + visible_amount[/code]. Can also count backwards. For example if a [TextEdit] has 5 lines with lines 2 and 3 hidden, calling this with [code]line = 1, visible_amount = 1[/code] would return 3. - - + + Returns the local position for the given [code]line[/code] and [code]column[/code]. If [code]x[/code] or [code]y[/code] of the returned vector equal [code]-1[/code], the position is outside of the viewable area of the control. [b]Note:[/b] The Y position corresponds to the bottom side of the line. Use [method get_rect_at_line_column] to get the top side position. @@ -360,8 +360,8 @@ - - + + Returns the local position and size for the grapheme at the given [code]line[/code] and [code]column[/code]. If [code]x[/code] or [code]y[/code] position of the returned rect equal [code]-1[/code], the position is outside of the viewable area of the control. [b]Note:[/b] The Y position of the returned rect corresponds to the top side of the line, unlike [method get_pos_at_line_column] which returns the bottom side. @@ -375,8 +375,8 @@ - - + + Returns the scroll position for [code]wrap_index[/code] of [code]line[/code]. @@ -461,15 +461,15 @@ - - + + Returns the total number of visible + wrapped lines between the two lines. - + Returns the word at [code]position[/code]. @@ -506,15 +506,15 @@ - - + + Inserts a new line with [code]text[/code] at [code]line[/code]. - + Insert the specified text at the caret position. @@ -533,36 +533,36 @@ - + Returns whether the gutter is clickable. - + Returns whether the gutter is currently drawn. - + Returns whether the gutter is overwritable. - - + + Returns whether the gutter on the given line is clickable. - + Returns if the given line is wrapped. @@ -575,7 +575,7 @@ - + Returns whether the mouse is over selection. If [code]edges[/code] is [code]true[/code], the edges are considered part of the selection. @@ -588,15 +588,15 @@ - + Triggers a right-click menu action by the specified index. See [enum MenuItems] for a list of available indexes. - - + + Merge the gutters from [code]from_line[/code] into [code]to_line[/code]. Only overwritable gutters will be copied. @@ -615,17 +615,17 @@ - + Removes the gutter from this [TextEdit]. - - - - + + + + Removes text between the given positions. [b]Note:[/b] This does not adjust the caret or selection, which as a result it can end up in an invalid position. @@ -633,10 +633,10 @@ - - - - + + + + Perform a search inside the text. Search flags can be specified in the [enum SearchFlags] enum. In the returned vector, [code]x[/code] is the column, [code]y[/code] is the line. If no results are found, both are equal to [code]-1[/code]. @@ -662,10 +662,10 @@ - - - - + + + + Perform selection, from line/column to line/column. If [member selecting_enabled] is [code]false[/code], no selection will occur. @@ -686,8 +686,8 @@ - - + + Moves the caret to the specified [code]column[/code] index. If [code]adjust_viewport[/code] is [code]true[/code], the viewport will center at the caret position after the move occurs. @@ -695,10 +695,10 @@ - - - - + + + + Moves the caret to the specified [code]line[/code] index. If [code]adjust_viewport[/code] is [code]true[/code], the viewport will center at the caret position after the move occurs. @@ -707,193 +707,193 @@ - - + + Sets the gutter as clickable. This will change the mouse cursor to a pointing hand when hovering over the gutter. - - + + Set a custom draw method for the gutter. The callback method must take the following args: [code]line: int, gutter: int, Area: Rect2[/code]. - - + + Sets whether the gutter should be drawn. - - + + Sets the name of the gutter. - - + + Sets the gutter to overwritable. See [method merge_gutters]. - - + + Sets the type of gutter. - - + + Set the width of the gutter. - - + + Sets the text for a specific line. - - + + Positions the [code]wrap_index[/code] of [code]line[/code] at the center of the viewport. - - + + Positions the [code]wrap_index[/code] of [code]line[/code] at the top of the viewport. - - + + Positions the [code]wrap_index[/code] of [code]line[/code] at the bottom of the viewport. - - + + Sets the current background color of the line. Set to [code]Color(0, 0, 0, 0)[/code] for no color. - - - + + + Sets the [code]gutter[/code] on [code]line[/code] as clickable. - - - + + + Sets the icon for [code]gutter[/code] on [code]line[/code]. - - - + + + Sets the color for [code]gutter[/code] on [code]line[/code]. - - - + + + Sets the metadata for [code]gutter[/code] on [code]line[/code]. - - - + + + Sets the text for [code]gutter[/code] on [code]line[/code]. - + If [code]true[/code], sets the user into overtype mode. When the user types in this mode, it will override existing text. - + Sets the search flags. This is used with [method set_search_text] to highlight occurrences of the searched text. Search flags can be specified from the [enum SearchFlags] enum. - + Sets the search text. See [method set_search_flags]. - - - + + + Sets the current selection mode. - + Sets the tab size for the [TextEdit] to use. - + Provide custom tooltip text. The callback method must take the following args: [code]hovered_word: String[/code] - - + + Swaps the two lines. @@ -1036,8 +1036,8 @@ - - + + Emitted when a gutter is clicked. @@ -1048,8 +1048,8 @@ - - + + Emitted immediately when the text changes. When text is added [code]from_line[/code] will be less then [code]to_line[/code]. On a remove [code]to_line[/code] will be less then [code]from_line[/code]. diff --git a/doc/classes/TextLine.xml b/doc/classes/TextLine.xml index 601650db2e..c7fd767743 100644 --- a/doc/classes/TextLine.xml +++ b/doc/classes/TextLine.xml @@ -11,21 +11,21 @@ - - - - + + + + Adds inline object to the text buffer, [code]key[/code] must be unique. In the text, object is represented as [code]length[/code] object replacement characters. - - - - - + + + + + Adds text span and font to draw it. @@ -38,19 +38,19 @@ - - - + + + Draw text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. - - - - + + + + Draw text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. @@ -87,7 +87,7 @@ - + Returns bounding rectangle of the inline object. @@ -112,23 +112,23 @@ - + Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. - - - + + + Sets new size and alignment of embedded object. - + Overrides BiDi for the structured text. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. @@ -136,7 +136,7 @@ - + Aligns text to the given tab-stops. diff --git a/doc/classes/TextParagraph.xml b/doc/classes/TextParagraph.xml index c733d8fcee..ea3815cec4 100644 --- a/doc/classes/TextParagraph.xml +++ b/doc/classes/TextParagraph.xml @@ -11,21 +11,21 @@ - - - - + + + + Adds inline object to the text buffer, [code]key[/code] must be unique. In the text, object is represented as [code]length[/code] object replacement characters. - - - - - + + + + + Adds text span and font to draw it. @@ -44,61 +44,61 @@ - - - - + + + + Draw all lines of the text and drop cap into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. - - - + + + Draw drop cap into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. - - - - + + + + Draw drop cap outline into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. - - - - + + + + Draw single line of text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. - - - - - + + + + + Draw outline of the single line of text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. - - - - - + + + + + Draw outlines of all lines of the text and drop cap into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. @@ -123,7 +123,7 @@ - + Returns the text line ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). @@ -136,64 +136,64 @@ - + Returns the text line descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). - - + + Returns bounding rectangle of the inline object. - + Returns array of inline objects in the line. - + Returns character range of the line. - + Returns TextServer line buffer RID. - + Returns size of the bounding box of the line of text. - + Returns pixel offset of the underline below the baseline. - + Returns thickness of the underline. - + Returns width (for horizontal layout) or height (for vertical) of the line of text. @@ -218,23 +218,23 @@ - + Returns caret character offset at the specified coordinates. This function always returns a valid position. - - - + + + Sets new size and alignment of embedded object. - + Overrides BiDi for the structured text. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. @@ -242,18 +242,18 @@ - - - - - + + + + + Sets drop cap, overrides previously set drop cap. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text. - + Aligns paragraph to the given tab-stops. diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index b54536f897..be3c04e913 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -17,8 +17,8 @@ - - + + Creates new buffer for complex text layout, with the given [code]direction[/code] and [code]orientation[/code]. To free the resulting buffer, use [method free_rid] method. [b]Note:[/b] Direction is ignored if server does not support [constant FEATURE_BIDI_LAYOUT] feature (supported by [TextServerAdvanced]). @@ -27,19 +27,19 @@ - - - - - + + + + + Draws box displaying character hexadecimal code. Used for replacing missing characters. - - + + Removes all rendered glyphs information from the cache entry. [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method font_remove_texture] to remove them manually. @@ -47,23 +47,23 @@ - - + + Removes all kerning overrides. - + Removes all font sizes from the cache entry. - - + + Removes all textures from font cache entry. [b]Note:[/b] This function will not remove glyphs associated with the texture, use [method font_remove_glyph] to remove them manually. @@ -71,12 +71,12 @@ - - - - - - + + + + + + Draws single glyph into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. [b]Note:[/b] Glyph index is specific to the font, use glyphs indices returned by [method shaped_text_get_glyphs] or [method font_get_glyph_index]. @@ -85,13 +85,13 @@ - - - - - - - + + + + + + + Draws single glyph outline of size [code]outline_size[/code] into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. [b]Note:[/b] Glyph index is specific to the font, use glyphs indices returned by [method shaped_text_get_glyphs] or [method font_get_glyph_index]. @@ -100,51 +100,51 @@ - - + + Returns the font ascent (number of pixels above the baseline). - - + + Returns the font descent (number of pixels below the baseline). - + Returns font embolden strength. - + Returns number of faces in the TrueType / OpenType collection. - + Recturns an active face index in the TrueType / OpenType collection. - + Returns bitmap font fixed size. - + Returns [code]true[/code] if font texture mipmap generation is enabled. @@ -157,9 +157,9 @@ - - - + + + Returns glyph advance (offset of the next glyph). [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. @@ -167,9 +167,9 @@ - - - + + + Returns outline contours of the glyph as a [code]Dictionary[/code] with the following contents: [code]points[/code] - [PackedVector3Array], containing outline points. [code]x[/code] and [code]y[/code] are point coordinates. [code]z[/code] is the type of the point, using the [enum ContourPointTag] values. @@ -179,54 +179,54 @@ - - - - + + + + Returns the glyph index of a [code]char[/code], optionally modified by the [code]variation_selector[/code]. - - + + Returns list of rendered glyphs in the cache entry. - - - + + + Returns glyph offset from the baseline. - - - + + + Returns size of the glyph. - - - + + + Returns index of the cache texture containing the glyph. - - - + + + Returns resource id of the cache texture containing the glyph. [b]Note:[/b] If there are pending glyphs to render, calling this function might trigger the texture cache update. @@ -234,9 +234,9 @@ - - - + + + Returns size of the cache texture containing the glyph. [b]Note:[/b] If there are pending glyphs to render, calling this function might trigger the texture cache update. @@ -244,251 +244,251 @@ - - - + + + Returns rectangle in the cache texture containing the glyph. - + Returns the font hinting mode. Used by dynamic fonts only. - - - + + + Returns kerning for the pair of glyphs. - - + + Returns list of the kerning overrides. - - + + Returns [code]true[/code] if support override is enabled for the [code]language[/code]. - + Returns list of language support overrides. - + Returns the width of the range around the shape between the minimum and maximum representable signed distance. - + Returns source font size used to generate MSDF textures. - + Returns font family name. - + Returns font OpenType feature set override. - + Returns font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. - - + + Returns scaling factor of the color bitmap font. - - + + Returns [code]true[/code] if support override is enabled for the [code]script[/code]. - + Returns list of script support overrides. - + Returns list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size. - + Returns font style flags, see [enum FontStyle]. - + Returns font style name. - + Returns font sub-pixel glyph positioning mode. - + Returns a string containing all the characters available in the font. - - + + Returns number of textures used by font cache entry. - - - + + + Returns font cache texture image data. - - - + + + Returns array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. - + Returns 2D transform applied to the font outlines. - - + + Returns pixel offset of the underline below the baseline. - - + + Returns thickness of the underline in pixels. - + Returns variation coordinates for the specified font cache entry. See [method font_supported_variation_list] for more info. - - + + Returns [code]true[/code] if a Unicode [code]char[/code] is available in the font. - + Returns [code]true[/code] if font 8-bit anitialiased glyph rendering is supported and enabled. - + Returns [code]true[/code] if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only. - - + + Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). - + Returns [code]true[/code] if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. - - + + Returns [code]true[/code], if font supports given script (ISO 15924 code). - - - + + + Removes specified rendered glyph information from the cache entry. [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method font_remove_texture] to remove them manually. @@ -496,42 +496,42 @@ - - - + + + Removes kerning override for the pair of glyphs. - - + + Remove language support override. - - + + Removes script support override. - - + + Removes specified font size from the cache entry. - - - + + + Removes specified texture from the cache entry. [b]Note:[/b] This function will not remove glyphs associated with the texture, remove them manually, using [method font_remove_glyph]. @@ -539,100 +539,100 @@ - - - + + + Renders specified glyph to the font cache texture. - - - - + + + + Renders the range of characters to the font cache texture. - - + + If set to [code]true[/code], 8-bit antialiased glyph rendering is used, otherwise 1-bit rendering is used. Used by dynamic fonts only. - - - + + + Sets the font ascent (number of pixels above the baseline). - - + + Sets font source data, e.g contents of the dynamic font source file. - - - + + + Sets the font descent (number of pixels below the baseline). - - + + Sets font embolden strength. If [code]strength[/code] is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. - - + + Sets an active face index in the TrueType / OpenType collection. - - + + Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes. - - + + If set to [code]true[/code] auto-hinting is preferred over font built-in hinting. - - + + If set to [code]true[/code] font texture mipmap generation is enabled. - + Sets oversampling factor, shared by all font in the TextServer. [b]Note:[/b] This value can be automatically changed by display server. @@ -640,10 +640,10 @@ - - - - + + + + Sets glyph advance (offset of the next glyph). [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. @@ -651,91 +651,91 @@ - - - - + + + + Sets glyph offset from the baseline. - - - - + + + + Sets size of the glyph. - - - - + + + + Sets index of the cache texture containing the glyph. - - - - + + + + Sets rectangle in the cache texture containing the glyph. - - + + Sets font hinting mode. Used by dynamic fonts only. - - - - + + + + Sets kerning for the pair of glyphs. - - - + + + Adds override for [method font_is_language_supported]. - - + + Sets the width of the range around the shape between the minimum and maximum representable signed distance. - - + + Sets source font size used to generate MSDF textures. - - + + If set to [code]true[/code], glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes. [b]Note:[/b] MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts. @@ -743,94 +743,94 @@ - - + + Sets the font family name. - - + + Sets font OpenType feature set override. - - + + Sets font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. - - - + + + Sets scaling factor of the color bitmap font. - - - + + + Adds override for [method font_is_script_supported]. - - + + Sets the font style flags, see [enum FontStyle]. - - + + Sets the font style name. - - + + Sets font sub-pixel glyph positioning mode. - - - - + + + + Sets font cache texture image data. - - - - + + + + Sets array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. - - + + Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. For example, to simulate italic typeface by slanting, apply the following transform [code]Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)[/code]. @@ -838,55 +838,55 @@ - - - + + + Sets pixel offset of the underline below the baseline. - - - + + + Sets thickness of the underline in pixels. - - + + Sets variation coordinates for the specified font cache entry. See [method font_supported_variation_list] for more info. - + Returns the dictionary of the supported OpenType features. - + Returns the dictionary of the supported OpenType variation coordinates. - - + + Converts a number from the Western Arabic (0..9) to the numeral systems used in [code]language[/code]. - + Frees an object created by this [TextServer]. @@ -899,8 +899,8 @@ - - + + Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters). @@ -925,22 +925,22 @@ - + Returns [code]true[/code] if [code]rid[/code] is valid resource owned by this text server. - + Returns [code]true[/code] if the server supports a feature. - - + + Returns index of the first string in [code]dict[/dict] which is visually confusable with the [code]string[/string], or [code]-1[/code] if none is found. [b]Note:[/b] This method doesn't detect invisible characters, for spoof detection use it in combination with [method spoof_check]. @@ -949,14 +949,14 @@ - + Returns [code]true[/code] if locale is right-to-left. - + Returns [code]true[/code] is [code]string[/code] is a valid identifier. If the text server supports the [constant FEATURE_UNICODE_IDENTIFIERS] feature, a valid identifier must: @@ -971,7 +971,7 @@ - + Loads optional TextServer database (e.g. ICU break iterators and dictionaries). [b]Note:[/b] This function should be called before any other TextServer functions used, otherwise it won't have any effect. @@ -979,38 +979,38 @@ - + Converts readable feature, variation, script or language name to OpenType tag. - - + + Converts a number from the numeral systems used in [code]language[/code] to Western Arabic (0..9). - - - + + + Default implementation of the BiDi algorithm override function. See [enum StructuredTextParser] for more info. - + Returns percent sign used in the [code]language[/code]. - + Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file. [b]Note:[/b] This function is used by during project export, to include TextServer database. @@ -1018,98 +1018,98 @@ - + Returns number of text spans added using [method shaped_text_add_string] or [method shaped_text_add_object]. - - + + Returns text span metadata. - - - - - + + + + + Changes text span font, font size and OpenType features, without changing the text. - - - - - + + + + + Adds inline object to the text buffer, [code]key[/code] must be unique. In the text, object is represented as [code]length[/code] object replacement characters. - - - - - - - + + + + + + + Adds text span and font to draw it to the text buffer. - + Clears text buffer (removes text and inline objects). - - - - - - + + + + + + Draw shaped text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). - - - - - - - + + + + + + + Draw the outline of the shaped text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). - - - + + + Adjusts text with to fit to specified width, returns new text width. - + Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). [b]Note:[/b] Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline. @@ -1117,22 +1117,22 @@ - - + + Returns shapes of the carets corresponding to the character offset [code]position[/code] in the text. Returned caret shape is 1 pixel wide rectangle. - + Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. - + Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). [b]Note:[/b] Overall descent can be higher than font descent, if some glyphs are displaced from the baseline. @@ -1140,130 +1140,130 @@ - + Returns direction of the text. - - - + + + Returns dominant direction of in the range of text. - + Returns number of glyphs in the ellipsis. - + Returns array of the glyphs in the ellipsis. - + Returns position of the ellipsis. - + Returns number of glyphs in the buffer. - + Returns an array of glyphs in the visual order. - - + + Returns composite character's bounds as offsets from the start of the line. - + Returns direction of the text, inferred by the BiDi algorithm. - - - - + + + + Breaks text to the lines and returns character ranges for each line. - - - - - + + + + + Breaks text to the lines and columns. Returns character ranges for each segment. - - + + Returns bounding rectangle of the inline object. - + Returns array of inline objects. - + Returns text orientation. - + Returns the parent buffer from which the substring originates. - + Returns [code]true[/code] if text buffer is configured to display control characters. - + Returns [code]true[/code] if text buffer is configured to display hexadecimal codes in place of invalid characters. [b]Note:[/b] If set to [code]false[/code], nothing is displayed in place of invalid characters. @@ -1271,133 +1271,133 @@ - + Returns substring buffer character range in the parent buffer. - - - + + + Returns selection rectangles for the specified character range. - + Returns size of the text. - - + + Returns extra spacing added between glyphs or lines in pixels. - + Returns the position of the overrun trim. - + Returns pixel offset of the underline below the baseline. - + Returns thickness of the underline. - + Returns width (for horizontal layout) or height (for vertical) of the text. - - + + Breaks text into words and returns array of character ranges. Use [code]grapheme_flags[/code] to set what characters are used for breaking (see [enum GraphemeFlag]). - - + + Returns grapheme index at the specified pixel offset at the baseline, or [code]-1[/code] if none is found. - - + + Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. - + Returns [code]true[/code] if buffer is successfully shaped. - - + + Returns composite character end position closest to the [code]pos[/code]. - - - + + + Trims text if it exceeds the given width. - - + + Returns composite character start position closest to the [code]pos[/code]. - - - - + + + + Sets new size and alignment of embedded object. - - + + Overrides BiDi for the structured text. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. @@ -1405,16 +1405,16 @@ - - + + Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. - - + + Sets desired text direction. If set to [code]TEXT_DIRECTION_AUTO[/code], direction will be detected based on the buffer contents and current locale. [b]Note:[/b] Direction is ignored if server does not support [constant FEATURE_BIDI_LAYOUT] feature (supported by [TextServerAdvanced]). @@ -1422,8 +1422,8 @@ - - + + Sets desired text orientation. [b]Note:[/b] Orientation is ignored if server does not support [constant FEATURE_VERTICAL_LAYOUT] feature (supported by [TextServerAdvanced]). @@ -1431,32 +1431,32 @@ - - + + If set to [code]true[/code] text buffer will display control characters. - - + + If set to [code]true[/code] text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed. - - - + + + Sets extra spacing added between glyphs or lines in pixels. - + Shapes buffer if it's not shaped. Returns [code]true[/code] if the string is shaped successfully. [b]Note:[/b] It is not necessary to call this function manually, buffer will be shaped automatically as soon as any of its output data is requested. @@ -1464,31 +1464,31 @@ - + Returns text glyphs in the logical order. - - - + + + Returns text buffer for the substring of the text in the [code]shaped[/code] text buffer (including inline objects). - - + + Aligns shaped text to the given tab-stops. - + Returns [code]true[/code] if [code]string[/code] is likely to be an attempt at confusing the reader. [b]Note:[/b] Always returns [code]false[/code] if the server does not support the [constant FEATURE_UNICODE_SECURITY] feature. @@ -1496,16 +1496,16 @@ - - + + Returns array of the word break character offsets. - - + + Returns the string converted to lowercase. [b]Note:[/b] Casing is locale dependent and context sensitive if server support [constant FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION] feature (supported by [TextServerAdvanced]). @@ -1514,8 +1514,8 @@ - - + + Returns the string converted to uppercase. [b]Note:[/b] Casing is locale dependent and context sensitive if server support [constant FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION] feature (supported by [TextServerAdvanced]). @@ -1524,7 +1524,7 @@ - + Strips diacritics from the string. [b]Note:[/b] The result may be longer or shorter than the original. @@ -1532,7 +1532,7 @@ - + Converts OpenType tag to readable feature, variation, script or language name. diff --git a/doc/classes/TextServerExtension.xml b/doc/classes/TextServerExtension.xml index c686a06e5e..acf6e5833d 100644 --- a/doc/classes/TextServerExtension.xml +++ b/doc/classes/TextServerExtension.xml @@ -17,19 +17,19 @@ - - + + Creates new buffer for complex text layout, with the given [code]direction[/code] and [code]orientation[/code]. To free the resulting buffer, use [method free_rid] method. - - - - - + + + + + Draws box displaying character hexadecimal code. Used for replacing missing characters. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -37,107 +37,107 @@ - - + + Removes all rendered glyphs information from the cache entry. - - + + Removes all kerning overrides. - + Removes all font sizes from the cache entry. - - + + Removes all textures from font cache entry. - - - - - - + + + + + + Draws single glyph into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. - - - - - - - + + + + + + + Draws single glyph outline of size [code]outline_size[/code] into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. - - + + Returns the font ascent (number of pixels above the baseline). - - + + Returns the font descent (number of pixels below the baseline). - + Returns font embolden strength. - + Returns number of faces in the TrueType / OpenType collection. - + Returns an active face index in the TrueType / OpenType collection. - + Returns bitmap font fixed size. - + Returns [code]true[/code] if font texture mipmap generation is enabled. @@ -150,18 +150,18 @@ - - - + + + Returns glyph advance (offset of the next glyph). - - - + + + Returns outline contours of the glyph as a [code]Dictionary[/code] with the following contents: [code]points[/code] - [PackedVector3Array], containing outline points. [code]x[/code] and [code]y[/code] are point coordinates. [code]z[/code] is the type of the point, using the [enum TextServer.ContourPointTag] values. @@ -171,465 +171,465 @@ - - - - + + + + Returns the glyph index of a [code]char[/code], optionally modified by the [code]variation_selector[/code]. - - + + Returns list of rendered glyphs in the cache entry. - - - + + + Returns glyph offset from the baseline. - - - + + + Returns size of the glyph. - - - + + + Returns index of the cache texture containing the glyph. - - - + + + Returns resource id of the cache texture containing the glyph. - - - + + + Returns size of the cache texture containing the glyph. - - - + + + Returns rectangle in the cache texture containing the glyph. - + Returns the font hinting mode. Used by dynamic fonts only. - - - + + + Returns kerning for the pair of glyphs. - - + + Returns list of the kerning overrides. - - + + Returns [code]true[/code] if support override is enabled for the [code]language[/code]. - + Returns list of language support overrides. - + Returns the width of the range around the shape between the minimum and maximum representable signed distance. - + Returns source font size used to generate MSDF textures. - + Returns font family name. - + Returns font OpenType feature set override. - + Returns font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. - - + + Returns scaling factor of the color bitmap font. - - + + Returns [code]true[/code] if support override is enabled for the [code]script[/code]. - + Returns list of script support overrides. - + Returns list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size. - + Returns font style flags, see [enum TextServer.FontStyle]. - + Returns font style name. - + Returns font sub-pixel glyph positioning mode. - + Returns a string containing all the characters available in the font. - - + + Returns number of textures used by font cache entry. - - - + + + Returns font cache texture image data. - - - + + + Returns array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. - + Returns 2D transform applied to the font outlines. - - + + Returns pixel offset of the underline below the baseline. - - + + Returns thickness of the underline in pixels. - + Returns variation coordinates for the specified font cache entry. See [method font_supported_variation_list] for more info. - - + + Returns [code]true[/code] if a Unicode [code]char[/code] is available in the font. - + Returns [code]true[/code] if font 8-bit anitialiased glyph rendering is supported and enabled. - + Returns [code]true[/code] if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only. - - + + Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). - + Returns [code]true[/code] if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. - - + + Returns [code]true[/code], if font supports given script (ISO 15924 code). - - - + + + Removes specified rendered glyph information from the cache entry. - - - + + + Removes kerning override for the pair of glyphs. - - + + Remove language support override. - - + + Removes script support override. - - + + Removes specified font size from the cache entry. - - - + + + Removes specified texture from the cache entry. - - - + + + Renders specified glyph to the font cache texture. - - - - + + + + Renders the range of characters to the font cache texture. - - + + If set to [code]true[/code], 8-bit antialiased glyph rendering is used, otherwise 1-bit rendering is used. Used by dynamic fonts only. - - - + + + Sets the font ascent (number of pixels above the baseline). - - + + Sets font source data, e.g contents of the dynamic font source file. - - - + + + Sets font source data, e.g contents of the dynamic font source file. [code]data_ptr[/code] memory buffer must remain accessible during font lifetime. - - - + + + Sets the font descent (number of pixels below the baseline). - - + + Sets font embolden strength. If [code]strength[/code] is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. - - + + Sets an active face index in the TrueType / OpenType collection. - - + + Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes. - - + + If set to [code]true[/code] auto-hinting is preferred over font built-in hinting. - - + + If set to [code]true[/code] font texture mipmap generation is enabled. - + Sets oversampling factor, shared by all font in the TextServer. [b]Note:[/b] This value can be automatically changed by display server. @@ -637,101 +637,101 @@ - - - - + + + + Sets glyph advance (offset of the next glyph). - - - - + + + + Sets glyph offset from the baseline. - - - - + + + + Sets size of the glyph. - - - - + + + + Sets index of the cache texture containing the glyph. - - - - + + + + Sets rectangle in the cache texture containing the glyph. - - + + Sets font hinting mode. Used by dynamic fonts only. - - - - + + + + Sets kerning for the pair of glyphs. - - - + + + Adds override for [method font_is_language_supported]. - - + + Sets the width of the range around the shape between the minimum and maximum representable signed distance. - - + + Sets source font size used to generate MSDF textures. - - + + If set to [code]true[/code], glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes. [b]Note:[/b] MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts. @@ -739,94 +739,94 @@ - - + + Sets the font family name. - - + + Sets font OpenType feature set override. - - + + Sets font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. - - - + + + Sets scaling factor of the color bitmap font. - - - + + + Adds override for [method font_is_script_supported]. - - + + Sets the font style flags, see [enum TextServer.FontStyle]. - - + + Sets the font style name. - - + + Sets font sub-pixel glyph positioning mode. - - - - + + + + Sets font cache texture image data. - - - - + + + + Sets array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. - - + + Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. For example, to simulate italic typeface by slanting, apply the following transform [code]Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)[/code]. @@ -834,55 +834,55 @@ - - - + + + Sets pixel offset of the underline below the baseline. - - - + + + Sets thickness of the underline in pixels. - - + + Sets variation coordinates for the specified font cache entry. See [method font_supported_variation_list] for more info. - + Returns the dictionary of the supported OpenType features. - + Returns the dictionary of the supported OpenType variation coordinates. - - + + Converts a number from the Western Arabic (0..9) to the numeral systems used in [code]language[/code]. - + Frees an object created by this [TextServer]. @@ -895,8 +895,8 @@ - - + + Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters). [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -922,80 +922,80 @@ - + Returns [code]true[/code] if [code]rid[/code] is valid resource owned by this text server. - + Returns [code]true[/code] if the server supports a feature. - - + + Returns index of the first string in [code]dict[/dict] which is visually confusable with the [code]string[/string], or [code]-1[/code] if none is found. - + Returns [code]true[/code] if locale is right-to-left. - + Returns [code]true[/code] is [code]string[/code] is a valid identifier. - + Loads optional TextServer database (e.g. ICU break iterators and dictionaries). - + Converts readable feature, variation, script or language name to OpenType tag. - - + + Converts a number from the numeral systems used in [code]language[/code] to Western Arabic (0..9). - - - + + + - + Returns percent sign used in the [code]language[/code]. - + Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file. [b]Note:[/b] This function is used by during project export, to include TextServer database. @@ -1003,69 +1003,69 @@ - + Returns number of text spans added using [method shaped_text_add_string] or [method shaped_text_add_object]. - - + + Returns text span metadata. - - - - - + + + + + Changes text span font, font size and OpenType features, without changing the text. - - - - - + + + + + Adds inline object to the text buffer, [code]key[/code] must be unique. In the text, object is represented as [code]length[/code] object replacement characters. - - - - - - - + + + + + + + Adds text span and font to draw it to the text buffer. - + Clears text buffer (removes text and inline objects). - - - - - - + + + + + + Draw shaped text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1073,13 +1073,13 @@ - - - - - - - + + + + + + + Draw the outline of the shaped text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1087,25 +1087,25 @@ - - - + + + Adjusts text with to fit to specified width, returns new text width. - + Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). - - - + + + Returns shapes of the carets corresponding to the character offset [code]position[/code] in the text. Returned caret shape is 1 pixel wide rectangle. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1113,30 +1113,30 @@ - + Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. - + Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). - + Returns direction of the text. - - - + + + Returns dominant direction of in the range of text. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1144,43 +1144,43 @@ - + Returns number of glyphs in the ellipsis. - + Returns array of the glyphs in the ellipsis. - + Returns position of the ellipsis. - + Returns number of glyphs in the buffer. - + Returns an array of glyphs in the visual order. - - + + Returns composite character's bounds as offsets from the start of the line. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1188,17 +1188,17 @@ - + Returns direction of the text, inferred by the BiDi algorithm. - - - - + + + + Breaks text to the lines and returns character ranges for each line. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1206,11 +1206,11 @@ - - - - - + + + + + Breaks text to the lines and columns. Returns character ranges for each segment. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1218,43 +1218,43 @@ - - + + Returns bounding rectangle of the inline object. - + Returns array of inline objects. - + eturns text orientation. - + Returns the parent buffer from which the substring originates. - + Returns [code]true[/code] if text buffer is configured to display control characters. - + Returns [code]true[/code] if text buffer is configured to display hexadecimal codes in place of invalid characters. [b]Note:[/b] If set to [code]false[/code], nothing is displayed in place of invalid characters. @@ -1262,16 +1262,16 @@ - + Returns substring buffer character range in the parent buffer. - - - + + + Returns selection rectangles for the specified character range. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1279,51 +1279,51 @@ - + Returns size of the text. - - + + Returns extra spacing added between glyphs or lines in pixels. - + Returns the position of the overrun trim. - + Returns pixel offset of the underline below the baseline. - + Returns thickness of the underline. - + Returns width (for horizontal layout) or height (for vertical) of the text. - - + + Breaks text into words and returns array of character ranges. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1331,8 +1331,8 @@ - - + + Returns grapheme index at the specified pixel offset at the baseline, or [code]-1[/code] if none is found. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1340,8 +1340,8 @@ - - + + Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1349,15 +1349,15 @@ - + Returns [code]true[/code] if buffer is successfully shaped. - - + + Returns composite character end position closest to the [code]pos[/code]. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1365,17 +1365,17 @@ - - - + + + Trims text if it exceeds the given width. - - + + Returns composite character start position closest to the [code]pos[/code]. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1383,18 +1383,18 @@ - - - - + + + + Sets new size and alignment of embedded object. - - + + Overrides BiDi for the structured text. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. @@ -1402,87 +1402,87 @@ - - + + Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. - - + + Sets desired text direction. If set to [code]TEXT_DIRECTION_AUTO[/code], direction will be detected based on the buffer contents and current locale. - - + + Sets desired text orientation. - - + + If set to [code]true[/code] text buffer will display control characters. - - + + If set to [code]true[/code] text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed. - - - + + + Sets extra spacing added between glyphs or lines in pixels. - + Shapes buffer if it's not shaped. Returns [code]true[/code] if the string is shaped successfully. - + Returns text glyphs in the logical order. - - - + + + Returns text buffer for the substring of the text in the [code]shaped[/code] text buffer (including inline objects). - - + + Aligns shaped text to the given tab-stops. - + Updates line breaking positions in the text buffer. [b]Note:[/b] This method is used by default line/word breaking methods, and its implementation might be omitted if custom line breaking in implemented. @@ -1490,7 +1490,7 @@ - + Updates line justification positions (word breaks and elongations) in the text buffer. [b]Note:[/b] This method is used by default line/word breaking methods, and its implementation might be omitted if custom line breaking in implemented. @@ -1498,38 +1498,38 @@ - + Returns [code]true[/code] if [code]string[/code] is likely to be an attempt at confusing the reader. - - + + Returns array of the word break character offsets. - - + + Returns the string converted to lowercase. - - + + Returns the string converted to uppercase. - + Strips diacritics from the string. [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. @@ -1537,7 +1537,7 @@ - + Converts OpenType tag to readable feature, variation, script or language name. diff --git a/doc/classes/TextServerManager.xml b/doc/classes/TextServerManager.xml index 7eff19038c..19b0e9e6f2 100644 --- a/doc/classes/TextServerManager.xml +++ b/doc/classes/TextServerManager.xml @@ -12,21 +12,21 @@ - + Registers an [TextServer] interface. - + Finds an interface by its name. - + Returns the interface registered at a given index. @@ -51,14 +51,14 @@ - + Removes interface. All fonts and shaped text caches should be freed before removing interface. - + Sets the primary [TextServer] interface. @@ -66,13 +66,13 @@ - + Emitted when a new interface has been added. - + Emitted when an interface is removed. diff --git a/doc/classes/Texture2D.xml b/doc/classes/Texture2D.xml index 3721058d25..a8ec2a7f06 100644 --- a/doc/classes/Texture2D.xml +++ b/doc/classes/Texture2D.xml @@ -14,31 +14,31 @@ - - - - + + + + - - - - - + + + + + - - - - - - + + + + + + @@ -59,40 +59,40 @@ - - + + - - - - + + + + Draws the texture using a [CanvasItem] with the [RenderingServer] API at the specified [code]position[/code]. - - - - - + + + + + Draws the texture using a [CanvasItem] with the [RenderingServer] API. - - - - - - + + + + + + Draws a part of the texture using a [CanvasItem] with the [RenderingServer] API. diff --git a/doc/classes/TextureLayered.xml b/doc/classes/TextureLayered.xml index 3445329f32..8d54521095 100644 --- a/doc/classes/TextureLayered.xml +++ b/doc/classes/TextureLayered.xml @@ -21,7 +21,7 @@ - + @@ -59,7 +59,7 @@ - + Returns an [Image] resource with the data from specified [code]layer[/code]. diff --git a/doc/classes/TextureProgressBar.xml b/doc/classes/TextureProgressBar.xml index 4ea072a25f..fcdb18e10d 100644 --- a/doc/classes/TextureProgressBar.xml +++ b/doc/classes/TextureProgressBar.xml @@ -11,14 +11,14 @@ - + - - + + diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index 7f4e0645c8..b310233780 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -15,7 +15,7 @@ - + Adds an empty theme type for every valid data type. [b]Note:[/b] Empty types are not saved with the theme. This method only exists to perform in-memory changes to the resource. Use available [code]set_*[/code] methods to add theme items. @@ -29,8 +29,8 @@ - - + + Removes the [Color] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_color] to check for existence. @@ -38,8 +38,8 @@ - - + + Removes the constant property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_constant] to check for existence. @@ -47,8 +47,8 @@ - - + + Removes the [Font] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_font] to check for existence. @@ -56,8 +56,8 @@ - - + + Removes the font size property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_font_size] to check for existence. @@ -65,8 +65,8 @@ - - + + Removes the icon property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_icon] to check for existence. @@ -74,8 +74,8 @@ - - + + Removes the [StyleBox] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_stylebox] to check for existence. @@ -83,9 +83,9 @@ - - - + + + Removes the theme property of [code]data_type[/code] defined by [code]name[/code] and [code]theme_type[/code], if it exists. Fails if it doesn't exist. Use [method has_theme_item] to check for existence. @@ -94,15 +94,15 @@ - + Unmarks [code]theme_type[/code] as being a variation of another theme type. See [method set_type_variation]. - - + + Returns the [Color] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns the default color value if the property doesn't exist. Use [method has_color] to check for existence. @@ -110,7 +110,7 @@ - + Returns a list of names for [Color] properties defined with [code]theme_type[/code]. Use [method get_color_type_list] to get a list of possible theme type names. @@ -123,8 +123,8 @@ - - + + Returns the constant property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns [code]0[/code] if the property doesn't exist. Use [method has_constant] to check for existence. @@ -132,7 +132,7 @@ - + Returns a list of names for constant properties defined with [code]theme_type[/code]. Use [method get_constant_type_list] to get a list of possible theme type names. @@ -145,8 +145,8 @@ - - + + Returns the [Font] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns the default theme font if the property doesn't exist and the default theme font is set up (see [member default_font]). Use [method has_font] to check for existence of the property and [method has_default_font] to check for existence of the default theme font. @@ -155,15 +155,15 @@ - + Returns a list of names for [Font] properties defined with [code]theme_type[/code]. Use [method get_font_type_list] to get a list of possible theme type names. - - + + Returns the font size property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns the default theme font size if the property doesn't exist and the default theme font size is set up (see [member default_font_size]). Use [method has_font_size] to check for existence of the property and [method has_default_font_size] to check for existence of the default theme font. @@ -172,7 +172,7 @@ - + Returns a list of names for font size properties defined with [code]theme_type[/code]. Use [method get_font_size_type_list] to get a list of possible theme type names. @@ -191,8 +191,8 @@ - - + + Returns the icon property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns the engine fallback icon value if the property doesn't exist. Use [method has_icon] to check for existence. @@ -200,7 +200,7 @@ - + Returns a list of names for icon properties defined with [code]theme_type[/code]. Use [method get_icon_type_list] to get a list of possible theme type names. @@ -213,8 +213,8 @@ - - + + Returns the [StyleBox] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns the engine fallback stylebox value if the property doesn't exist. Use [method has_stylebox] to check for existence. @@ -222,7 +222,7 @@ - + Returns a list of names for [StyleBox] properties defined with [code]theme_type[/code]. Use [method get_stylebox_type_list] to get a list of possible theme type names. @@ -235,9 +235,9 @@ - - - + + + Returns the theme property of [code]data_type[/code] defined by [code]name[/code] and [code]theme_type[/code], if it exists. Returns the engine fallback icon value if the property doesn't exist. Use [method has_theme_item] to check for existence. @@ -246,8 +246,8 @@ - - + + Returns a list of names for properties of [code]data_type[/code] defined with [code]theme_type[/code]. Use [method get_theme_item_type_list] to get a list of possible theme type names. [b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic. @@ -255,7 +255,7 @@ - + Returns a list of all unique theme type names for [code]data_type[/code] properties. Use [method get_type_list] to get a list of all unique theme types. [b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic. @@ -269,22 +269,22 @@ - + Returns the name of the base theme type if [code]theme_type[/code] is a valid variation type. Returns an empty string otherwise. - + Returns a list of all type variations for the given [code]base_type[/code]. - - + + Returns [code]true[/code] if the [Color] property defined by [code]name[/code] and [code]theme_type[/code] exists. Returns [code]false[/code] if it doesn't exist. Use [method set_color] to define it. @@ -292,8 +292,8 @@ - - + + Returns [code]true[/code] if the constant property defined by [code]name[/code] and [code]theme_type[/code] exists. Returns [code]false[/code] if it doesn't exist. Use [method set_constant] to define it. @@ -322,8 +322,8 @@ - - + + Returns [code]true[/code] if the [Font] property defined by [code]name[/code] and [code]theme_type[/code] exists, or if the default theme font is set up (see [method has_default_font]). Returns [code]false[/code] if neither exist. Use [method set_font] to define the property. @@ -331,8 +331,8 @@ - - + + Returns [code]true[/code] if [member default_font_size] has a valid value. Returns [code]false[/code] if it doesn't. The value must be greater than [code]0[/code] to be considered valid. @@ -340,8 +340,8 @@ - - + + Returns [code]true[/code] if the icon property defined by [code]name[/code] and [code]theme_type[/code] exists. Returns [code]false[/code] if it doesn't exist. Use [method set_icon] to define it. @@ -349,8 +349,8 @@ - - + + Returns [code]true[/code] if the [StyleBox] property defined by [code]name[/code] and [code]theme_type[/code] exists. Returns [code]false[/code] if it doesn't exist. Use [method set_stylebox] to define it. @@ -358,9 +358,9 @@ - - - + + + Returns [code]true[/code] if the theme property of [code]data_type[/code] defined by [code]name[/code] and [code]theme_type[/code] exists. Returns [code]false[/code] if it doesn't exist. Use [method set_theme_item] to define it. @@ -369,15 +369,15 @@ - - + + Returns [code]true[/code] if [code]theme_type[/code] is marked as a variation of [code]base_type[/code]. - + Adds missing and overrides existing definitions with values from the [code]other[/code] theme resource. [b]Note:[/b] This modifies the current theme. If you want to merge two themes together without modifying either one, create a new empty theme and merge the other two into it one after another. @@ -385,16 +385,16 @@ - + Removes the theme type, gracefully discarding defined theme items. If the type is a variation, this information is also erased. If the type is a base for type variations, those variations lose their base. - - - + + + Renames the [Color] property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_color] to check for existence, and [method clear_color] to remove the existing property. @@ -402,9 +402,9 @@ - - - + + + Renames the constant property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_constant] to check for existence, and [method clear_constant] to remove the existing property. @@ -412,9 +412,9 @@ - - - + + + Renames the [Font] property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_font] to check for existence, and [method clear_font] to remove the existing property. @@ -422,9 +422,9 @@ - - - + + + Returns [code]true[/code] if the font size property defined by [code]name[/code] and [code]theme_type[/code] exists, or if the default theme font size is set up (see [method has_default_font_size]). Returns [code]false[/code] if neither exist. Use [method set_font_size] to define the property. @@ -432,9 +432,9 @@ - - - + + + Renames the icon property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_icon] to check for existence, and [method clear_icon] to remove the existing property. @@ -442,9 +442,9 @@ - - - + + + Renames the [StyleBox] property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_stylebox] to check for existence, and [method clear_stylebox] to remove the existing property. @@ -452,10 +452,10 @@ - - - - + + + + Renames the theme property of [code]data_type[/code] defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_theme_item] to check for existence, and [method clear_theme_item] to remove the existing property. @@ -464,36 +464,36 @@ - - - + + + Creates or changes the value of the [Color] property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_color] to remove the property. - - - + + + Creates or changes the value of the constant property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_constant] to remove the property. - - - + + + Creates or changes the value of the [Font] property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_font] to remove the property. - - - + + + Renames the font size property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_font_size] to check for existence, and [method clear_font_size] to remove the existing property. @@ -501,28 +501,28 @@ - - - + + + Creates or changes the value of the icon property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_icon] to remove the property. - - - + + + Creates or changes the value of the [StyleBox] property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_stylebox] to remove the property. - - - - + + + + Creates or changes the value of the theme property of [code]data_type[/code] defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_theme_item] to remove the property. Fails if the [code]value[/code] type is not accepted by [code]data_type[/code]. @@ -531,8 +531,8 @@ - - + + Marks [code]theme_type[/code] as a variation of [code]base_type[/code]. This adds [code]theme_type[/code] as a suggested option for [member Control.theme_type_variation] on a [Control] that is of the [code]base_type[/code] class. diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index 513daff37c..6bc34ed8dd 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -34,8 +34,8 @@ - - + + Starts a new [Thread] that calls [code]callable[/code]. If the method takes some arguments, you can pass them using [method Callable.bind]. diff --git a/doc/classes/TileData.xml b/doc/classes/TileData.xml index 66cf602e5d..b61ed1ea28 100644 --- a/doc/classes/TileData.xml +++ b/doc/classes/TileData.xml @@ -9,186 +9,186 @@ - + Adds a collision polygon to the tile on the given TileSet physics layer. - - + + Returns the one-way margin (for one-way platforms) of the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. - - + + Returns the points of the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. - + Returns how many polygons the tile has for TileSet physics layer with index [code]layer_id[/code]. - + Returns the constant angular velocity applied to objects colliding with this tile. - + Returns the constant linear velocity applied to objects colliding with this tile. - + Returns the custom data value for custom data layer named [code]layer_name[/code]. - + Returns the custom data value for custom data layer with index [code]layer_id[/code]. - + Returns the navigation polygon of the tile for the TileSet navigation layer with index [code]layer_id[/code]. - + Returns the occluder polygon of the tile for the TileSet occlusion layer with index [code]layer_id[/code]. - + Returns the tile's terrain bit for the given [code]peering_bit[/code] direction. - - + + Returns whether one-way collisions are enabled for the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. - - + + Removes the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. - - - + + + Enables/disables one-way collisions on the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. - - - + + + Enables/disables one-way collisions on the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. - - - + + + Sets the points of the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code]. - - + + Sets the polygons count for TileSet physics layer with index [code]layer_id[/code]. - - + + Sets the constant angular velocity. This does not rotate the tile. This angular velocity is applied to objects colliding with this tile. - - + + Sets the constant linear velocity. This does not move the tile. This linear velocity is applied to objects colliding with this tile. This is useful to create conveyor belts. - - + + Sets the tile's custom data value for the TileSet custom data layer with name [code]layer_name[/code]. - - + + Sets the tile's custom data value for the TileSet custom data layer with index [code]layer_id[/code]. - - + + Sets the navigation polygon for the TileSet navigation layer with index [code]layer_id[/code]. - - + + Sets the occluder for the TileSet occlusion layer with index [code]layer_id[/code]. - - + + Sets the tile's terrain bit for the given [code]peering_bit[/code] direction. diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index d532f583e6..d13276ad54 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -18,9 +18,9 @@ - - - + + + Called with a TileData object about to be used internally by the TileMap, allowing its modification at runtime. This method is only called if [method _use_tile_data_runtime_update] is implemented and returns [code]true[/code] for the given tile [code]coords[/coords] and [code]layer[/code]. @@ -30,8 +30,8 @@ - - + + Should return [code]true[/code] if the tile at coordinates [code]coords[/coords] on layer [code]layer[/code] requires a runtime update. [b]Warning:[/b] Make sure this function only return [code]true[/code] when needed. Any tile processed at runtime without a need for it will imply a significant performance penalty. @@ -39,7 +39,7 @@ - + Adds a layer at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. @@ -52,15 +52,15 @@ - + Clears all cells on the given layer. - - + + Erases the cell on layer [code]layer[/code] at coordinates [code]coords[/code]. @@ -73,7 +73,7 @@ - + Triggers an update of the TileMap. If [code]layer[/code] is provided, only updates the given layer. [b]Note:[/b] The TileMap node updates automatically when one of its properties is modified. A manual update is only needed if runtime modifications (implemented in [method _tile_data_runtime_update]) need to be applied. @@ -82,62 +82,62 @@ - - - + + + Returns the tile alternative ID of the cell on layer [code]layer[/code] at [code]coords[/code]. If [code]use_proxies[/code] is [code]false[/code], ignores the [TileSet]'s tile proxies, returning the raw alternative identifier. See [method TileSet.map_tile_proxy]. - - - + + + Returns the tile atlas coordinates ID of the cell on layer [code]layer[/code] at coordinates [code]coords[/code]. If [code]use_proxies[/code] is [code]false[/code], ignores the [TileSet]'s tile proxies, returning the raw alternative identifier. See [method TileSet.map_tile_proxy]. - - - + + + Returns the tile source ID of the cell on layer [code]layer[/code] at coordinates [code]coords[/code]. If [code]use_proxies[/code] is [code]false[/code], ignores the [TileSet]'s tile proxies, returning the raw alternative identifier. See [method TileSet.map_tile_proxy]. - + Returns the coordinates of the tile for given physics body RID. Such RID can be retrieved from [method KinematicCollision2D.get_collider_rid], when colliding with a tile. - + Returns a TileMap layer's modulate. - + Returns a TileMap layer's name. - + Returns a TileMap layer's Y sort origin. - + Returns a TileMap layer's Z-index value. @@ -149,30 +149,30 @@ - - + + Returns the neighboring cell to the one at coordinates [code]coords[/code], identified by the [code]neighbor[/code] direction. This method takes into account the different layouts a TileMap can take. - - + + Creates a new [TileMapPattern] from the given layer and set of cells. - + Returns the list of all neighbourings cells to the one at [code]coords[/code] - + Returns a [Vector2] array with the positions of all cells containing a tile in the given layer. A cell is considered empty if its source identifier equals -1, its atlas coordinates identifiers is [code]Vector2(-1, -1)[/code] and its alternative identifier is -1. @@ -185,30 +185,30 @@ - + Returns if a layer is enabled. - + Returns if a layer Y-sorts its tiles. - - - + + + Returns for the given coordinate [code]coords_in_pattern[/code] in a [TileMapPattern] the corresponding cell coordinates if the pattern was pasted at the [code]position_in_tilemap[/code] coordinates (see [method set_pattern]). This mapping is required as in half-offset tile shapes, the mapping might not work by calculating [code]position_in_tile_map + coords_in_pattern[/code] - + Returns a local position of the center of the cell at the given tilemap (grid-based) coordinates. [b]Note:[/b] This doesn't correspond to the visual position of the tile, i.e. it ignores the [member TileData.texture_offset] property of individual tiles. @@ -216,26 +216,26 @@ - - + + Moves the layer at index [code]layer_index[/code] to the given position [code]to_position[/code] in the array. - + Removes the layer at index [code]layer[/code]. - - - - - + + + + + Sets the tile indentifiers for the cell on layer [code]layer[/code] at coordinates [code]coords[/code]. Each tile of the [TileSet] is identified using three parts: - The source identifier [code]source_id[/code] identifies a [TileSetSource] identifier. See [method TileSet.set_source_id], @@ -245,11 +245,11 @@ - - - - - + + + + + Update all the cells in the [code]cells[/code] coordinates array so that they use the given [code]terrain[/code] for the given [code]terrain_set[/code]. If an updated cell has the same terrain as one of its neighboring cells, this function tries to join the two. This function might update neighboring tiles if needed to create correct terrain transitions. If [code]ignore_empty_terrains[/code] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. If [code]ignore_empty_terrains[/code] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. @@ -258,11 +258,11 @@ - - - - - + + + + + Update all the cells in the [code]cells[/code] coordinates array so that they use the given [code]terrain[/code] for the given [code]terrain_set[/code]. The function will also connect two successive cell in the path with the same terrain. This function might update neighboring tiles if needed to create correct terrain transitions. If [code]ignore_empty_terrains[/code] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. @@ -271,32 +271,32 @@ - - + + Enables or disables the layer [code]layer[/code]. A disabled layer is not processed at all (no rendering, no physics, etc...). - - + + Sets a layer's color. It will be multiplied by tile's color and TileMap's modulate. - - + + Sets a layer's name. This is mostly useful in the editor. - - + + Enables or disables a layer's Y-sorting. If a layer is Y-sorted, the layer will behave as a CanvasItem node where each of its tile gets Y-sorted. Y-sorted layers should usually be on different Z-index values than not Y-sorted layers, otherwise, each of those layer will be Y-sorted as whole with the Y-sorted one. This is usually an undesired behvaior. @@ -304,8 +304,8 @@ - - + + Sets a layer's Y-sort origin value. This Y-sort origin value is added to each tile's Y-sort origin value. This allows, for example, to fake a different height level on each layer. This can be useful for top-down view games. @@ -313,24 +313,24 @@ - - + + Sets a layers Z-index value. This Z-index is added to each tile's Z-index value. - - - + + + Paste the given [TileMapPattern] at the given [code]position[/code] and [code]layer[/code] in the tile map. - + Returns the tilemap (grid-based) coordinates corresponding to the given local position. diff --git a/doc/classes/TileMapPattern.xml b/doc/classes/TileMapPattern.xml index 5fe514d3da..a499b31503 100644 --- a/doc/classes/TileMapPattern.xml +++ b/doc/classes/TileMapPattern.xml @@ -12,21 +12,21 @@ - + Returns the tile alternative ID of the cell at [code]coords[/code]. - + Returns the tile atlas coordinates ID of the cell at [code]coords[/code]. - + Returns the tile source ID of the cell at [code]coords[/code]. @@ -45,7 +45,7 @@ - + Returns whether the pattern has a tile at the given coordinates. @@ -58,25 +58,25 @@ - - + + Remove the cell at the given coordinates. - - - - + + + + Sets the tile indentifiers for the cell at coordinates [code]coords[/code]. See [method TileMap.set_cell]. - + Sets the size of the pattern. diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 180e868ef8..5e2b4b64fb 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -24,7 +24,7 @@ - + Adds a custom data layer to the TileSet at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. Custom data layers allow assigning custom properties to atlas tiles. @@ -32,7 +32,7 @@ - + Adds a navigation layer to the TileSet at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. Navigation layers allow assigning a navigable area to atlas tiles. @@ -40,7 +40,7 @@ - + Adds an occlusion layer to the TileSet at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. Occlusion layers allow assigning occlusion polygons to atlas tiles. @@ -48,15 +48,15 @@ - - + + Adds a [TileMapPattern] to be stored in the TileSet resource. If provided, insert it at the given [code]index[/code]. - + Adds a physics layer to the TileSet at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. Physics layers allow assigning collision polygons to atlas tiles. @@ -64,8 +64,8 @@ - - + + Adds a [TileSetSource] to the TileSet. If [code]atlas_source_id_override[/code] is not -1, also set its source ID. Otherwise, a unique identifier is automatically generated. The function returns the added source source ID or -1 if the source could not be added. @@ -73,15 +73,15 @@ - - + + Adds a new terrain to the given terrain set [code]terrain_set[/code] at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. - + Adds a new terrain set at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array. @@ -100,9 +100,9 @@ - - - + + + Returns the alternative-level proxy for the given identifiers. The returned array contains the three proxie's target identifiers (source ID, atlas coords ID and alternative tile ID). If the TileSet has no proxy for the given identifiers, returns an empty Array. @@ -110,8 +110,8 @@ - - + + Returns the coordinate-level proxy for the given identifiers. The returned array contains the two target identifiers of the proxy (source ID and atlas coordinates ID). If the TileSet has no proxy for the given identifiers, returns an empty Array. @@ -119,21 +119,21 @@ - + Returns the index of the custom data layer identified by the given name. - + Returns the name of the custom data layer identified by the given index. - + Returns the type of the custom data layer identified by the given index. @@ -146,7 +146,7 @@ - + Returns the navigation layers (as in the Navigation server) of the gives TileSet navigation layer. @@ -165,14 +165,14 @@ - + Returns the light mask of the occlusion layer. - + Returns if the occluders from this layer use [code]sdf_collision[/code]. @@ -185,7 +185,7 @@ - + Returns the [TileMapPattern] at the given [code]index[/code]. @@ -198,21 +198,21 @@ - + Returns the collision layer (as in the physics server) bodies on the given TileSet's physics layer are in. - + Returns the collision mask of bodies on the given TileSet's physics layer. - + Returns the physics material of bodies on the given TileSet's physics layer. @@ -225,7 +225,7 @@ - + Returns the [TileSetSource] with ID [code]source_id[/code]. @@ -238,14 +238,14 @@ - + Returns the source ID for source with index [code]index[/code]. - + Returns the source-level proxy for the given source identifier. If the TileSet has no proxy for the given identifier, returns -1. @@ -253,23 +253,23 @@ - - + + Returns a terrain's color. - - + + Returns a terrain's name. - + Returns a terrain set mode. @@ -282,47 +282,47 @@ - + Returns the number of terrains in the given terrain set. - - - + + + Returns if there is and alternative-level proxy for the given identifiers. - - + + Returns if there is a coodinates-level proxy for the given identifiers. - + Returns if this TileSet has a source for the given source ID. - + Returns if there is a source-level proxy for the given source ID. - - - + + + According to the configured proxies, maps the provided indentifiers to a new set of identifiers. The source ID, atlas coordinates ID and alternative tile ID are returned as a 3 elements Array. This function first look for matching alternative-level proxies, then coordinates-level proxies, then source-level proxies. @@ -331,142 +331,142 @@ - - + + Moves the custom data layer at index [code]layer_index[/code] to the given position [code]to_position[/code] in the array. Also updates the atlas tiles accordingly. - - + + Moves the navigation layer at index [code]layer_index[/code] to the given position [code]to_position[/code] in the array. Also updates the atlas tiles accordingly. - - + + Moves the occlusion layer at index [code]layer_index[/code] to the given position [code]to_position[/code] in the array. Also updates the atlas tiles accordingly. - - + + Moves the physics layer at index [code]layer_index[/code] to the given position [code]to_position[/code] in the array. Also updates the atlas tiles accordingly. - - - + + + Moves the terrain at index [code]terrain_index[/code] for terrain set [code]terrain_set[/code] to the given position [code]to_position[/code] in the array. Also updates the atlas tiles accordingly. - - + + Moves the terrain set at index [code]terrain_set[/code] to the given position [code]to_position[/code] in the array. Also updates the atlas tiles accordingly. - - - + + + Removes an alternative-level proxy for the given identifiers. - - + + Removes a coordinates-level proxy for the given identifiers. - + Removes the custom data layer at index [code]layer_index[/code]. Also updates the atlas tiles accordingly. - + Removes the navigation layer at index [code]layer_index[/code]. Also updates the atlas tiles accordingly. - + Removes the occlusion layer at index [code]layer_index[/code]. Also updates the atlas tiles accordingly. - + Remove the [TileMapPattern] at the given index. - + Removes the physics layer at index [code]layer_index[/code]. Also updates the atlas tiles accordingly. - + Removes the source with the given source ID. - + Removes a source-level tile proxy. - - + + Removes the terrain at index [code]terrain_index[/code] in the given terrain set [code]terrain_set[/code]. Also updates the atlas tiles accordingly. - + Removes the terrain set at index [code]terrain_set[/code]. Also updates the atlas tiles accordingly. - - - - - - + + + + + + Create an alternative-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. This can be used to replace a tile in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target tile when one is available. @@ -475,10 +475,10 @@ - - - - + + + + Creates a coordinates-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. The alternative tile ID is kept the same when using coordinates-level proxies. This can be used to replace a tile in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target tile when one is available. @@ -487,80 +487,80 @@ - - + + Sets the name of the custom data layer identified by the given index. Names are identifiers of the layer therefore if the name is already taken it will fail and raise an error. - - + + Sets the type of the custom data layer identified by the given index. - - + + Sets the navigation layers (as in the navigation server) for navigation regions is the given TileSet navigation layer. - - + + Sets the occlusion layer (as in the rendering server) for occluders in the given TileSet occlusion layer. - - + + Enables or disables sdf collision for occluders in the given TileSet occlusion layer. - - + + Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer. - - + + Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer. - - + + Sets the physics material for bodies in the given TileSet physics layer. - - + + Changes a source's ID. - - + + Creates a source-level proxy for the given source ID. A proxy will map set of tile identifiers to another set of identifiers. Both the atlac coordinates ID and the alternative tile ID are kept the same when using source-level proxies. This can be used to replace a source in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target source when one is available. @@ -569,26 +569,26 @@ - - - + + + Sets a terrain's color. This color is used for identifying the different terrains in the TileSet editor. - - - + + + Sets a terrain's name. - - + + Sets a terrain mode. Each mode determines which bits of a tile shape is used to match the neighbouring tiles' terrains. diff --git a/doc/classes/TileSetAtlasSource.xml b/doc/classes/TileSetAtlasSource.xml index db4e52f661..9053a81628 100644 --- a/doc/classes/TileSetAtlasSource.xml +++ b/doc/classes/TileSetAtlasSource.xml @@ -17,8 +17,8 @@ - - + + Creates an alternative tile for the tile at coords [code]atlas_coords[/code]. If [code]alternative_id_override[/code] is -1, give it an automatically generated unique ID, or assigns it the given ID otherwise. Returns the new alternative identifier, or -1 if the alternative could not be created with a provided [code]alternative_id_override[/code]. @@ -26,8 +26,8 @@ - - + + Creates a new tile at coords [code]atlas_coords[/code] with size [code]size[/code]. @@ -40,7 +40,7 @@ - + Returns the alternative ID a following call to [method create_alternative_tile] would return. @@ -53,8 +53,8 @@ - - + + Returns the region of the tile at coordinates [code]atlas_coords[/code] for frame [code]frame[/code] inside the texture returned by [method get_runtime_texture]. [b]Note:[/b] If [member use_texture_padding] is [code]false[/code], returns the same as [method get_tile_texture_region]. @@ -62,104 +62,104 @@ - + Returns how many columns the tile at [code]atlas_coords[/code] has in its animation layout. - - + + Returns the animation frame duration of frame [code]frame_index[/code] for the tile at coordinates [code]atlas_coords[/code]. - + Returns how many animation frames has the tile at coordinates [code]atlas_coords[/code]. - + Returns the separation (as in the atlas grid) between each frame of an animated tile at coordinates [code]atlas_coords[/code]. - + Returns the animation speed of the tile at coordinates [code]atlas_coords[/code]. - + Returns the sum of the sum of the frame durations of the tile at coordinates [code]atlas_coords[/code]. This value needs to be divided by the animation speed to get the actual animation loop duration. - + If there is a tile covering the [code]atlas_coords[/code] coordinates, returns the top-left coordinates of the tile (thus its coordinate ID). Returns [code]Vector2i(-1, -1)[/code] otherwise. - - + + Returns the [TileData] object for the given atlas coordinates and alternative ID. - + Returns the size of the tile (in the grid coordinates system) at coordinates [code]atlas_coords[/code]. - - + + Returns a tile's texture region in the atlas texture. For animated tiles, a [code]frame[/code] argument might be provided for the different frames of the animation. - - - - + + + + Returns an array of tiles coordinates ID that will be automatically removed when modifying one or several of those properties: [code]texture[/code], [code]margins[/code], [code]separation[/code] or [code]texture_region_size[/code]. This can be used to undo changes that would have caused tiles data loss. - - - - - - + + + + + + Returns whether there is enough room in an atlas to create/modify a tile with the given properties. If [code]ignored_tile[/code] is provided, act as is the given tile was not present in the atlas. This may be used when you want to modify a tile's properties. - - - + + + Move the tile and its alternatives at the [code]atlas_coords[/code] coordinates to the [code]new_atlas_coords[/code] coordinates with the [code]new_size[/code] size. This functions will fail if a tile is already present in the given area. If [code]new_atlas_coords[/code] is [code]Vector2i(-1, -1)[/code], keeps the tile's coordinates. If [code]new_size[/code] is [code]Vector2i(-1, -1)[/code], keeps the tile's size. @@ -168,8 +168,8 @@ - - + + Remove a tile's alternative with alternative ID [code]alternative_tile[/code]. Calling this function with [code]alternative_tile[/code] equals to 0 will fail, as the base tile alternative cannot be removed. @@ -177,16 +177,16 @@ - + Remove a tile and its alternative at coordinates [code]atlas_coords[/code]. - - - + + + Change a tile's alternative ID from [code]alternative_tile[/code] to [code]new_id[/code]. Calling this function with [code]alternative_id[/code] equals to 0 will fail, as the base tile alternative cannot be moved. @@ -194,41 +194,41 @@ - - + + Sets the number of columns in the animation layout of the tile at coordinates [code]atlas_coords[/code]. If set to 0, then the different frames of the animation are laid out as a single horizontal line in the atlas. - - - + + + Sets the animation frame duration of frame [code]frame_index[/code] for the tile at coordinates [code]atlas_coords[/code]. - - + + Sets how many animation frames the tile at coordinates [code]atlas_coords[/code] has. - - + + Sets the margin (in grid tiles) between each tile in the animation layout of the tile at coordinates [code]atlas_coords[/code] has. - - + + Sets the animation speed of the tile at coordinates [code]atlas_coords[/code] has. diff --git a/doc/classes/TileSetScenesCollectionSource.xml b/doc/classes/TileSetScenesCollectionSource.xml index a8ef253933..f6e13de060 100644 --- a/doc/classes/TileSetScenesCollectionSource.xml +++ b/doc/classes/TileSetScenesCollectionSource.xml @@ -12,8 +12,8 @@ - - + + Creates a scene-based tile out of the given scene. Returns a newly generated unique ID. @@ -27,21 +27,21 @@ - + Returns whether the scene tile with id [code]id[/code] displays a placeholder in the editor. - + Returns the scene tile ID of the scene tile at index [code]index[/code]. - + Returns the [PackedScene] resource of scene tile with id [code]id[/code]. @@ -54,38 +54,38 @@ - + Returns whether this TileSet source has a scene tile with id [code]id[/code]. - + Remove the scene tile with id [code]id[/code]. - - + + Sets whether or not the scene tile with id [code]id[/code] should display a placeholder in the editor. This might be useful for scenes that are not visible. - - + + Changes a scene tile's ID from [code]id[/code] to [code]new_id[/code]. This will fail if there is already a tile with a ID equal to [code]new_id[/code]. - - + + Assigns a [PackedScene] resource to the scene tile with id [code]id[/code]. This will fail if the scene does not extend CanvasItem, as positioning properties are needed to place the scene on the TileMap. diff --git a/doc/classes/TileSetSource.xml b/doc/classes/TileSetSource.xml index 3d23975e37..ae5c3717f2 100644 --- a/doc/classes/TileSetSource.xml +++ b/doc/classes/TileSetSource.xml @@ -15,15 +15,15 @@ - - + + Returns the alternative ID for the tile with coordinates ID [code]atlas_coords[/code] at index [code]index[/code]. - + Returns the number of alternatives tiles for the coordinates ID [code]atlas_coords[/code]. For [TileSetAtlasSource], this always return at least 1, as the base tile with ID 0 is always part of the alternatives list. @@ -32,7 +32,7 @@ - + Returns the tile coordinates ID of the tile with index [code]index[/code]. @@ -45,15 +45,15 @@ - - + + Returns if the base tile at coordinates [code]atlas_coords[/code] has an alternative with ID [code]alternative_tile[/code]. - + Returns if this atlas has a tile with coordinates ID [code]atlas_coordinates[/code]. diff --git a/doc/classes/Time.xml b/doc/classes/Time.xml index 5fc85c869b..e213be2e12 100644 --- a/doc/classes/Time.xml +++ b/doc/classes/Time.xml @@ -15,7 +15,7 @@ - + Returns the current date as a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], and [code]dst[/code] (Daylight Savings Time). The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. @@ -23,14 +23,14 @@ - + Converts the given Unix timestamp to a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], and [code]weekday[/code]. - + Returns the current date as an ISO 8601 date string (YYYY-MM-DD). The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. @@ -38,15 +38,15 @@ - + Converts the given Unix timestamp to an ISO 8601 date string (YYYY-MM-DD). - - + + Converts the given ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS) to a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code]. If [code]weekday[/code] is false, then the [code]weekday[/code] entry is excluded (the calculation is relatively expensive). @@ -55,14 +55,14 @@ - + Returns the current date as a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code]. - + Converts the given Unix timestamp to a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], and [code]weekday[/code]. The returned Dictionary's values will be the same as the [method get_datetime_dict_from_system] if the Unix timestamp is the current time, with the exception of Daylight Savings Time as it cannot be determined from the epoch. @@ -70,8 +70,8 @@ - - + + Converts the given dictionary of keys to an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). The given dictionary can be populated with the following keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code]. Any other entries (including [code]dst[/code]) are ignored. @@ -81,8 +81,8 @@ - - + + Returns the current date and time as an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. @@ -91,8 +91,8 @@ - - + + Converts the given Unix timestamp to an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). If [code]use_space[/code] is true, use a space instead of the letter T in the middle. @@ -100,7 +100,7 @@ - + Converts the given timezone offset in minutes to a timezone offset string. For example, -480 returns "-08:00", 345 returns "+05:45", and 0 returns "+00:00". @@ -121,7 +121,7 @@ - + Returns the current time as a dictionary of keys: [code]hour[/code], [code]minute[/code], and [code]second[/code]. The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. @@ -129,14 +129,14 @@ - + Converts the given time to a dictionary of keys: [code]hour[/code], [code]minute[/code], and [code]second[/code]. - + Returns the current time as an ISO 8601 time string (HH:MM:SS). The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. @@ -144,7 +144,7 @@ - + Converts the given Unix timestamp to an ISO 8601 time string (HH:MM:SS). @@ -157,7 +157,7 @@ - + Converts a dictionary of time values to a Unix timestamp. The given dictionary can be populated with the following keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code]. Any other entries (including [code]dst[/code]) are ignored. @@ -168,7 +168,7 @@ - + Converts the given ISO 8601 date and/or time string to a Unix timestamp. The string can contain a date only, a time only, or both. [b]Note:[/b] Unix timestamps are often in UTC. This method does not do any timezone conversion, so the timestamp will be in the same timezone as the given datetime string. diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index ebe25ed55e..70325c0227 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -19,7 +19,7 @@ - + Starts the timer. Sets [member wait_time] to [code]time_sec[/code] if [code]time_sec > 0[/code]. This also resets the remaining time to [member wait_time]. [b]Note:[/b] This method will not resume a paused timer. See [member paused]. diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 9979a73527..3b76348c09 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -22,34 +22,34 @@ - + Constructs a [Transform2D] as a copy of the given [Transform2D]. - - + + Constructs the transform from a given angle (in radians) and position. - - - - + + + + Constructs the transform from a given angle (in radians), scale, skew (in radians) and position. - - - + + + Constructs the transform from 3 [Vector2] values representing [member x], [member y], and the [member origin] (the three column vectors). @@ -64,7 +64,7 @@ - + Returns a vector transformed (multiplied) by the basis matrix. This method does not account for translation (the origin vector). @@ -72,7 +72,7 @@ - + Returns a vector transformed (multiplied) by the inverse basis matrix. This method does not account for translation (the origin vector). @@ -104,8 +104,8 @@ - - + + Returns a transform interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0). @@ -118,14 +118,14 @@ - + Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. - + Returns a copy of the transform rotated such that it's rotation on the X-axis points towards the [code]target[/code] position. Operations take place in global space. @@ -139,7 +139,7 @@ - + Returns a copy of the transform rotated by the given [code]angle[/code] (in radians). This method is an optimized version of multiplying the given transform [code]X[/code] @@ -149,7 +149,7 @@ - + Returns a copy of the transform rotated by the given [code]angle[/code] (in radians). This method is an optimized version of multiplying the given transform [code]X[/code] @@ -159,7 +159,7 @@ - + Returns a copy of the transform scaled by the given [code]scale[/code] factor. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -169,7 +169,7 @@ - + Returns a copy of the transform scaled by the given [code]scale[/code] factor. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -179,14 +179,14 @@ - + Sets the transform's rotation (in radians). - + Sets the transform's scale. [b]Note:[/b] Negative X scales in 2D are not decomposable from the transformation matrix. Due to the way scale is represented with transformation matrices in Godot, negative scales on the X axis will be changed to negative scales on the Y axis and a rotation of 180 degrees when decomposed. @@ -194,14 +194,14 @@ - + Sets the transform's skew (in radians). - + Returns a copy of the transform translated by the given [code]offset[/code]. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -211,7 +211,7 @@ - + Returns a copy of the transform translated by the given [code]offset[/code]. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -245,7 +245,7 @@ - + Returns [code]true[/code] if the transforms are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -253,49 +253,49 @@ - + Transforms (multiplies) each element of the [Vector2] array by the given [Transform2D] matrix. - + Transforms (multiplies) the [Rect2] by the given [Transform2D] matrix. - + Composes these two transformation matrices by multiplying them together. This has the effect of transforming the second transform (the child) by the first transform (the parent). - + Transforms (multiplies) the [Vector2] by the given [Transform2D] matrix. - + This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. - + This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. - + Returns [code]true[/code] if the transforms are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -303,7 +303,7 @@ - + Access transform components using their index. [code]t[0][/code] is equivalent to [code]t.x[/code], [code]t[1][/code] is equivalent to [code]t.y[/code], and [code]t[2][/code] is equivalent to [code]t.origin[/code]. diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml index cefc74867c..b7fd5213aa 100644 --- a/doc/classes/Transform3D.xml +++ b/doc/classes/Transform3D.xml @@ -24,31 +24,31 @@ - + Constructs a [Transform3D] as a copy of the given [Transform3D]. - - + + Constructs a Transform3D from a [Basis] and [Vector3]. - + - - - - + + + + Constructs a Transform3D from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled). @@ -63,8 +63,8 @@ - - + + Returns a transform interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0). @@ -77,15 +77,15 @@ - + Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. - - + + Returns a copy of the transform rotated such that the forward axis (-Z) points towards the [code]target[/code] position. The up axis (+Y) points as close to the [code]up[/code] vector as possible while staying perpendicular to the forward axis. The resulting transform is orthonormalized. The existing rotation, scale, and skew information from the original transform is discarded. The [code]target[/code] and [code]up[/code] vectors cannot be zero, cannot be parallel to each other, and are defined in global/parent space. @@ -99,8 +99,8 @@ - - + + Returns a copy of the transform rotated around the given [code]axis[/code] by the given [code]angle[/code] (in radians). The [code]axis[/code] must be a normalized vector. @@ -111,8 +111,8 @@ - - + + Returns a copy of the transform rotated around the given [code]axis[/code] by the given [code]angle[/code] (in radians). The [code]axis[/code] must be a normalized vector. @@ -123,7 +123,7 @@ - + Returns a copy of the transform scaled by the given [code]scale[/code] factor. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -133,7 +133,7 @@ - + Returns a copy of the transform scaled by the given [code]scale[/code] factor. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -143,15 +143,15 @@ - - + + Returns a transform spherically interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0). - + Returns a copy of the transform translated by the given [code]offset[/code]. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -161,7 +161,7 @@ - + Returns a copy of the transform translated by the given [code]offset[/code]. This method is an optimized version of multiplying the given transform [code]X[/code] @@ -195,7 +195,7 @@ - + Returns [code]true[/code] if the transforms are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -203,56 +203,56 @@ - + Transforms (multiplies) the [AABB] by the given [Transform3D] matrix. - + Transforms (multiplies) each element of the [Vector3] array by the given [Transform3D] matrix. - + Transforms (multiplies) the [Plane] by the given [Transform3D] transformation matrix. - + Composes these two transformation matrices by multiplying them together. This has the effect of transforming the second transform (the child) by the first transform (the parent). - + Transforms (multiplies) the [Vector3] by the given [Transform3D] matrix. - + This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly. - + This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly. - + Returns [code]true[/code] if the transforms are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml index 7aafbc68c6..3da778335d 100644 --- a/doc/classes/Translation.xml +++ b/doc/classes/Translation.xml @@ -13,27 +13,27 @@ - - + + Virtual method to override [method get_message]. - - - - + + + + Virtual method to override [method get_plural_message]. - - - + + + Adds a message if nonexistent, followed by its translation. An additional context could be used to specify the translation context or differentiate polysemic words. @@ -41,9 +41,9 @@ - - - + + + Adds a message involving plural translation if nonexistent, followed by its translation. An additional context could be used to specify the translation context or differentiate polysemic words. @@ -51,16 +51,16 @@ - - + + Erases a message. - - + + Returns a message's translation. @@ -79,10 +79,10 @@ - - - - + + + + Returns a message's translation involving plurals. The number [code]n[/code] is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language. diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index a4cf070ede..53ce5894eb 100644 --- a/doc/classes/TranslationServer.xml +++ b/doc/classes/TranslationServer.xml @@ -13,7 +13,7 @@ - + Adds a [Translation] resource. @@ -26,8 +26,8 @@ - - + + Compares two locales and return similarity score between [code]0[/code](no match) and [code]10[/code](full match). @@ -52,14 +52,14 @@ - + Returns readable country name for the [code]country[/code] code. - + Returns readable language name for the [code]language[/code] code. @@ -79,14 +79,14 @@ - + Returns a locale's language and its variant (e.g. [code]"en_US"[/code] would return [code]"English (United States)"[/code]). - + Returns readable script name for the [code]script[/code] code. @@ -100,7 +100,7 @@ - + Returns the [Translation] instance based on the [code]locale[/code] passed in. It will return [code]null[/code] if there is no [Translation] instance that matches the [code]locale[/code]. @@ -108,7 +108,7 @@ - + Returns the pseudolocalized string based on the [code]p_message[/code] passed in. @@ -121,14 +121,14 @@ - + Removes the given translation from the server. - + Sets the locale of the project. The [code]locale[/code] string will be standardized to match known locales (e.g. [code]en-US[/code] would be matched to [code]en_US[/code]). If translations have been loaded beforehand for the new locale, they will be applied. @@ -136,25 +136,25 @@ - + Returns [code]locale[/code] string standardized to match known locales (e.g. [code]en-US[/code] would be matched to [code]en_US[/code]). - - + + Returns the current locale's translation for the given message (key) and context. - - - - + + + + Returns the current locale's translation for the given message (key), plural_message and context. The number [code]n[/code] is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language. diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index f326948e9c..7825f2210f 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -44,8 +44,8 @@ - - + + Creates an item in the tree and adds it as a child of [code]parent[/code], which can be either a valid [TreeItem] or [code]null[/code]. If [code]parent[/code] is [code]null[/code], the root item will be the parent, or the new item will be the root itself if the tree is empty. @@ -68,48 +68,48 @@ - + Returns the button id at [code]position[/code], or -1 if no button is there. - + Returns the column index at [code]position[/code], or -1 if no item is there. - + - + Returns the column's title. - + Returns column title base writing direction. - + Returns column title language code. - + Returns the column's width in pixels. @@ -122,7 +122,7 @@ - + Returns the drop section at [code]position[/code], or -100 if no item is there. Values -1, 0, or 1 will be returned for the "above item", "on item", and "below item" drop sections, respectively. See [enum DropModeFlags] for a description of each drop section. @@ -163,23 +163,23 @@ - - - + + + Returns the rectangle area for the specified [TreeItem]. If [code]column[/code] is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. If a button index is specified, the rectangle of that button will be returned. - + Returns the tree item at the specified position (relative to the tree origin position). - + Returns the next selected [TreeItem] after the given one, or [code]null[/code] if the end is reached. If [code]from[/code] is [code]null[/code], this returns the first selected item. @@ -221,74 +221,74 @@ - + - + - - + + Causes the [Tree] to jump to the specified [TreeItem]. - - + + - - + + Overrides the calculated minimum width of a column. It can be set to `0` to restore the default behavior. Columns that have the "Expand" flag will use their "min_width" in a similar fashion to [member Control.size_flags_stretch_ratio]. - - + + If [code]true[/code], the column will have the "Expand" flag of [Control]. Columns that have the "Expand" flag will use their "min_width" in a similar fashion to [member Control.size_flags_stretch_ratio]. - - + + - - + + Sets the title of a column. - - + + Sets column title base writing direction. - - + + Sets language code of column title used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -331,10 +331,10 @@ - - - - + + + + Emitted when a button on the tree was pressed (see [method TreeItem.add_button]). @@ -345,33 +345,33 @@ - - + + Emitted when [method TreeItem.propagate_check] is called. Connect to this signal to process the items that are affected when [method TreeItem.propagate_check] is invoked. The order that the items affected will be processed is as follows: the item that invoked the method, children of that item, and finally parents of that item. - + Emitted when a column's title is pressed. - + Emitted when an item with [constant TreeItem.CELL_MODE_CUSTOM] is clicked with a mouse button. - + Emitted when a cell with the [constant TreeItem.CELL_MODE_CUSTOM] is clicked to be edited. - - + + Emitted when a mouse button is clicked in the empty space of the tree. @@ -382,7 +382,7 @@ - + Emitted when an item is collapsed by a click on the folding arrow. @@ -403,8 +403,8 @@ - - + + Emitted when an item is selected with a mouse button. @@ -415,9 +415,9 @@ - - - + + + Emitted instead of [code]item_selected[/code] if [code]select_mode[/code] is [constant SELECT_MULTI]. diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index fbba1147a2..519c3afadb 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -12,39 +12,39 @@ - - - - - + + + + + Adds a button with [Texture2D] [code]button[/code] at column [code]column[/code]. The [code]id[/code] is used to identify the button. If not specified, the next available index is used, which may be retrieved by calling [method get_button_count] immediately before this method. Optionally, the button can be [code]disabled[/code] and have a [code]tooltip[/code]. - + Calls the [code]method[/code] on the actual TreeItem and its children recursively. Pass parameters as a comma separated list. - + Resets the background color for the given column to default. - + Resets the color for the given column to default. - + Creates an item and adds it as a child. The new item will be inserted as position [code]idx[/code] (the default value [code]-1[/code] means the last position), or it will be the last child if [code]idx[/code] is higher than the child count. @@ -52,68 +52,68 @@ - + Deselects the given column. - - + + Removes the button at index [code]button_idx[/code] in column [code]column[/code]. - - + + Returns the [Texture2D] of the button at index [code]button_idx[/code] in column [code]column[/code]. - - + + Returns the button index if there is a button with id [code]id[/code] in column [code]column[/code], otherwise returns -1. - + Returns the number of buttons in column [code]column[/code]. - - + + Returns the id for the button at index [code]button_idx[/code] in column [code]column[/code]. - - + + Returns the tooltip string for the button at index [code]button_idx[/code] in column [code]column[/code]. - + Returns the column's cell mode. - + Returns a child item by its index (see [method get_child_count]). This method is often used for iterating all children of an item. Negative indices access the children from the last one. @@ -133,35 +133,35 @@ - + Returns the custom background color of column [code]column[/code]. - + Returns the custom color of column [code]column[/code]. - + Returns custom font used to draw text in the column [code]column[/code]. - + Returns custom font size used to draw text in the column [code]column[/code]. - + Returns [code]true[/code] if [code]expand_right[/code] is set. @@ -174,28 +174,28 @@ - + Returns the given column's icon [Texture2D]. Error if no icon is set. - + Returns the column's icon's maximum width. - + Returns the [Color] modulating the column's icon. - + Returns the icon [Texture2D] region as [Rect2]. @@ -208,14 +208,14 @@ - + Returns item's text language code. - + Returns the metadata value that was set for the given column using [method set_metadata]. @@ -228,7 +228,7 @@ - + Returns the next visible sibling TreeItem in the tree or a null object if there is none. If [code]wrap[/code] is enabled, the method will wrap around to the first visible element in the tree when called on the last visible element, otherwise it returns [code]null[/code]. @@ -248,7 +248,7 @@ - + Returns the previous visible sibling TreeItem in the tree or a null object if there is none. If [code]wrap[/code] is enabled, the method will wrap around to the last visible element in the tree when called on the first visible element, otherwise it returns [code]null[/code]. @@ -256,61 +256,61 @@ - + Returns the value of a [constant CELL_MODE_RANGE] column. - + Returns a dictionary containing the range parameters for a given column. The keys are "min", "max", "step", and "expr". - + - + - + Gets the suffix string shown after the column value. - + Returns the given column's text. - + Returns the given column's text alignment. - + Returns item's text base writing direction. - + Returns the given column's tooltip. @@ -323,56 +323,56 @@ - - + + Returns [code]true[/code] if the button at index [code]button_idx[/code] for the given column is disabled. - + Returns [code]true[/code] if the given column is checked. - + - + Returns [code]true[/code] if column [code]column[/code] is editable. - + Returns [code]true[/code] if the given column is indeterminate. - + Returns [code]true[/code] if column [code]column[/code] is selectable. - + Returns [code]true[/code] if column [code]column[/code] is selected. - + Moves this TreeItem right after the given [code]item[/code]. [b]Note:[/b] You can't move to the root or move the root. @@ -380,7 +380,7 @@ - + Moves this TreeItem right before the given [code]item[/code]. [b]Note:[/b] You can't move to the root or move the root. @@ -388,89 +388,89 @@ - - + + Propagates this item's checked status to its children and parents for the given [code]column[/code]. It is possible to process the items affected by this method call by connecting to [signal Tree.check_propagated_to_item]. The order that the items affected will be processed is as follows: the item invoking this method, children of that item, and finally parents of that item. If [code]emit_signal[/code] is [code]false[/code], then [signal Tree.check_propagated_to_item] will not be emitted. - + Removes the given child [TreeItem] and all its children from the [Tree]. Note that it doesn't free the item from memory, so it can be reused later. To completely remove a [TreeItem] use [method Object.free]. - + Selects the column [code]column[/code]. - - - + + + Sets the given column's button [Texture2D] at index [code]button_idx[/code] to [code]button[/code]. - - - + + + If [code]true[/code], disables the button at index [code]button_idx[/code] in column [code]column[/code]. - - + + Sets the given column's cell mode to [code]mode[/code]. See [enum TreeCellMode] constants. - - + + If [code]true[/code], the column [code]column[/code] is checked. Clears column's indeterminate status. - - + + - - - + + + Sets the given column's custom background color and whether to just use it as an outline. - - + + Sets the given column's custom color. - - - + + + Sets the given column's custom draw callback to [code]callback[/code] method on [code]object[/code]. The [code]callback[/code] should accept two arguments: the [TreeItem] that is drawn and its position and size as a [Rect2]. @@ -478,72 +478,72 @@ - - + + Sets custom font used to draw text in the column [code]column[/code]. - - + + Sets custom font size used to draw text in the column [code]column[/code]. - - + + If [code]true[/code], column [code]column[/code] is editable. - - + + If [code]true[/code], column [code]column[/code] is expanded to the right. - - + + Sets the given column's icon [Texture2D]. - - + + Sets the given column's icon's maximum width. - - + + Modulates the given column's icon with [code]modulate[/code]. - - + + Sets the given column's icon's texture region. - - + + If [code]true[/code], the column [code]column[/code] is marked indeterminate. [b]Note:[/b] If set [code]true[/code] from [code]false[/code], then column is cleared of checked status. @@ -551,35 +551,35 @@ - - + + Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. - - + + Sets the metadata value for the given column, which can be retrieved later using [method get_metadata]. This can be used, for example, to store a reference to the original data. - - + + Sets the value of a [constant CELL_MODE_RANGE] column. - - - - - + + + + + Sets the range of accepted values for a column. The column must be in the [constant CELL_MODE_RANGE] mode. If [code]expr[/code] is [code]true[/code], the edit mode slider will use an exponential scale as with [member Range.exp_edit]. @@ -587,62 +587,62 @@ - - + + If [code]true[/code], the given column is selectable. - - + + - - + + - - + + Sets a string to be shown after a column's value (for example, a unit abbreviation). - - + + Sets the given column's text value. - - + + Sets the given column's text alignment. See [enum HorizontalAlignment] for possible values. - - + + Sets item's text base writing direction. - - + + Sets the given column's tooltip text. diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index b18232f5c3..a808a996b7 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -45,7 +45,7 @@ - + Binds this [Tween] with the given [code]node[/code]. [Tween]s are processed directly by the [SceneTree], so they run independently of the animated nodes. When you bind a [Node] with the [Tween], the [Tween] will halt the animation when the object is not inside tree and the [Tween] will be automatically killed when the bound object is freed. Also [constant TWEEN_PAUSE_BOUND] will make the pausing behavior dependent on the bound node. For a shorter way to create and bind a [Tween], you can use [method Node.create_tween]. @@ -65,7 +65,7 @@ - + Processes the [Tween] by the given [code]delta[/code] value, in seconds. This is mostly useful for manual control when the [Tween] is paused. It can also be used to end the [Tween] animation immediately, by setting [code]delta[/code] longer than the whole duration of the [Tween] animation. Returns [code]true[/code] if the [Tween] still has [Tweener]s that haven't finished. @@ -81,12 +81,12 @@ - - - - - - + + + + + + This method can be used for manual interpolation of a value, when you don't want [Tween] to do animating for you. It's similar to [method @GlobalScope.lerp], but with support for custom transition and easing. [code]initial_value[/code] is the starting value of the interpolation. @@ -142,14 +142,14 @@ - + Sets the default ease type for [PropertyTweener]s and [MethodTweener]s animated by this [Tween]. - + Sets the number of times the tweening sequence will be repeated, i.e. [code]set_loops(2)[/code] will run the animation twice. Calling this method without arguments will make the [Tween] run infinitely, until either it is killed with [method kill], the [Tween]'s bound node is freed, or all the animated objects have been freed (which makes further animation impossible). @@ -158,14 +158,14 @@ - + If [code]parallel[/code] is [code]true[/code], the [Tweener]s appended after this method will by default run simultaneously, as opposed to sequentially. - + Determines the behavior of the [Tween] when the [SceneTree] is paused. Check [enum TweenPauseMode] for options. Default value is [constant TWEEN_PAUSE_BOUND]. @@ -173,7 +173,7 @@ - + Determines whether the [Tween] should run during idle frame (see [method Node._process]) or physics frame (see [method Node._physics_process]. Default value is [constant TWEEN_PROCESS_IDLE]. @@ -181,14 +181,14 @@ - + Scales the speed of tweening. This affects all [Tweener]s and their delays. - + Sets the default transition type for [PropertyTweener]s and [MethodTweener]s animated by this [Tween]. @@ -201,7 +201,7 @@ - + Creates and appends a [CallbackTweener]. This method can be used to call an arbitrary method in any object. Use [method Callable.bind] to bind additional arguments for the call. Example: object that keeps shooting every 1 second. @@ -219,7 +219,7 @@ - + Creates and appends an [IntervalTweener]. This method can be used to create delays in the tween animation, as an alternative to using the delay in other [Tweener]s, or when there's no animation (in which case the [Tween] acts as a timer). [code]time[/code] is the length of the interval, in seconds. Example: creating an interval in code execution. @@ -242,10 +242,10 @@ - - - - + + + + Creates and appends a [MethodTweener]. This method is similar to a combination of [method tween_callback] and [method tween_property]. It calls a method over time with a tweened value provided as an argument. The value is tweened between [code]from[/code] and [code]to[/code] over the time specified by [code]duration[/code], in seconds. Use [method Callable.bind] to bind additional arguments for the call. You can use [method MethodTweener.set_ease] and [method MethodTweener.set_trans] to tweak the easing and transition of the value or [method MethodTweener.set_delay] to delay the tweening. Example: making a 3D object look from one point to another point. @@ -266,10 +266,10 @@ - - - - + + + + Creates and appends a [PropertyTweener]. This method tweens a [code]property[/code] of an [code]object[/code] between an initial value and [code]final_val[/code] in a span of time equal to [code]duration[/code], in seconds. The initial value by default is the property's value at the time the tweening of the [PropertyTweener] starts. For example: [codeblock] @@ -296,13 +296,13 @@ - + Emitted when a full loop is complete (see [method set_loops]), providing the loop index. This signal is not emitted after the final loop, use [signal finished] instead for this case. - + Emitted when one step of the [Tween] is complete, providing the step index. One step is either a single [Tweener] or a group of [Tweener]s running in parallel. diff --git a/doc/classes/UDPServer.xml b/doc/classes/UDPServer.xml index 6fb4d50c0c..49dee4d132 100644 --- a/doc/classes/UDPServer.xml +++ b/doc/classes/UDPServer.xml @@ -143,8 +143,8 @@ - - + + Starts the server by opening a UDP socket listening on the given port. You can optionally specify a [code]bind_address[/code] to only listen for packets sent to that address. See also [method PacketPeerUDP.bind]. diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index 80a548ceaf..4c955a7322 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -64,55 +64,55 @@ - - + + Register a method that will be called when the action is committed. - - - + + + Register a property value change for "do". - + Register a reference for "do" that will be erased if the "do" history is lost. This is useful mostly for new nodes created for the "do" call. Do not use for resources. - - + + Register a method that will be called when the action is undone. - - - + + + Register a property value change for "undo". - + Register a reference for "undo" that will be erased if the "undo" history is lost. This is useful mostly for nodes removed with the "do" call (not the "undo" call!). - + Clear the undo/redo history and associated references. Passing [code]false[/code] to [code]increase_version[/code] will prevent the version number to be increased from this. @@ -120,15 +120,15 @@ - + Commit the action. If [code]execute[/code] is true (default), all "do" methods/properties are called/set when this function is called. - - + + Create a new action. After this is called, do all your calls to [method add_do_method], [method add_undo_method], [method add_do_property], and [method add_undo_property], then commit the action with [method commit_action]. The way actions are merged is dictated by the [code]merge_mode[/code] argument. See [enum MergeMode] for details. @@ -142,7 +142,7 @@ - + Gets the action name from its index. diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 454db51919..56c107f5cd 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -25,22 +25,22 @@ - + Constructs a [Vector2] as a copy of the given [Vector2]. - + Constructs a new [Vector2] from [Vector2i]. - - + + Constructs a new [Vector2] from the given [code]x[/code] and [code]y[/code]. @@ -64,7 +64,7 @@ - + Returns the angle to the given vector, in radians. [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/vector2_angle_to.png]Illustration of the returned angle.[/url] @@ -72,7 +72,7 @@ - + Returns the angle between the line connecting the two points and the X axis, in radians. [code]a.angle_to_point(b)[/code] is equivalent of doing [code](b - a).angle()[/code]. @@ -87,17 +87,17 @@ - - - - + + + + Returns the point at the given [code]t[/code] on the [url=https://en.wikipedia.org/wiki/B%C3%A9zier_curve]Bezier curve[/url] defined by this vector and the given [code]control_1[/code], [code]control_2[/code], and [code]end[/code] points. - + Returns the vector "bounced off" from a plane defined by the given normal. @@ -110,15 +110,15 @@ - - + + Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. - + Returns the 2D analog of the cross product for this vector and [code]with[/code]. This is the signed area of the parallelogram formed by the two vectors. If the second vector is clockwise from the first vector, then the cross product is the positive area. If counter-clockwise, the cross product is the negative area. @@ -127,24 +127,24 @@ - - - - + + + + Cubically interpolates between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. - + Returns the normalized vector pointing from this vector to [code]to[/code]. This is equivalent to using [code](b - a).normalized()[/code]. - + Returns the squared distance between this vector and [code]to[/code]. This method runs faster than [method distance_to], so prefer it if you need to compare vectors or need the squared distance for some formula. @@ -152,14 +152,14 @@ - + Returns the distance between this vector and [code]to[/code]. - + Returns the dot product of this vector and [code]with[/code]. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. The dot product will be [code]0[/code] for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees. @@ -175,7 +175,7 @@ - + Creates a unit [Vector2] rotated to the given [code]angle[/code] in radians. This is equivalent to doing [code]Vector2(cos(angle), sin(angle))[/code] or [code]Vector2.RIGHT.rotated(angle)[/code]. [codeblock] @@ -187,7 +187,7 @@ - + Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. @@ -213,15 +213,15 @@ - - + + Returns the result of the linear interpolation between this vector and [code]to[/code] by amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. - + Returns the vector with a maximum length by limiting its length to [code]length[/code]. @@ -240,8 +240,8 @@ - - + + Returns a new vector moved toward [code]to[/code] by the fixed [code]delta[/code] amount. Will not go past the final value. @@ -260,35 +260,35 @@ - + Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]mod[/code]. - + Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]modv[/code]'s components. - + Returns this vector projected onto the vector [code]b[/code]. - + Returns the vector reflected (i.e. mirrored, or symmetric) over a line defined by the given direction vector [code]n[/code]. - + Returns the vector rotated by [code]angle[/code] (in radians). See also [method @GlobalScope.deg2rad]. @@ -307,8 +307,8 @@ - - + + Returns the result of spherical linear interpolation between this vector and [code]to[/code], by amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. This method also handles interpolating the lengths if the input vectors have different lengths. For the special case of one or both input vectors having zero length, this method behaves like [method lerp]. @@ -316,14 +316,14 @@ - + Returns this vector slid along a plane defined by the given normal. - + Returns this vector with each component snapped to the nearest multiple of [code]step[/code]. This can also be used to round to an arbitrary number of decimals. @@ -369,7 +369,7 @@ - + Returns [code]true[/code] if the vectors are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -377,14 +377,14 @@ - + Inversely transforms (multiplies) the [Vector2] by the given [Transform2D] transformation matrix. - + Multiplies each component of the [Vector2] by the components of the given [Vector2]. [codeblock] @@ -394,21 +394,21 @@ - + Multiplies each component of the [Vector2] by the given [float]. - + Multiplies each component of the [Vector2] by the given [int]. - + Adds each component of the [Vector2] by the components of the given [Vector2]. [codeblock] @@ -418,7 +418,7 @@ - + Subtracts each component of the [Vector2] by the components of the given [Vector2]. [codeblock] @@ -428,7 +428,7 @@ - + Divides each component of the [Vector2] by the components of the given [Vector2]. [codeblock] @@ -438,35 +438,35 @@ - + Divides each component of the [Vector2] by the given [float]. - + Divides each component of the [Vector2] by the given [int]. - + Compares two [Vector2] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. - + Compares two [Vector2] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. - + Returns [code]true[/code] if the vectors are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -474,21 +474,21 @@ - + Compares two [Vector2] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. - + Compares two [Vector2] vectors by first checking if the X value of the left vector is greater than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. - + Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], and [code]v[1][/code] is equivalent to [code]v.y[/code]. diff --git a/doc/classes/Vector2i.xml b/doc/classes/Vector2i.xml index 28d68b6e44..a60fd09a48 100644 --- a/doc/classes/Vector2i.xml +++ b/doc/classes/Vector2i.xml @@ -22,22 +22,22 @@ - + Constructs a [Vector2i] as a copy of the given [Vector2i]. - + Constructs a new [Vector2i] from [Vector2]. The floating point coordinates will be truncated. - - + + Constructs a new [Vector2i] from the given [code]x[/code] and [code]y[/code]. @@ -58,8 +58,8 @@ - - + + Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. @@ -133,14 +133,14 @@ - + Returns [code]true[/code] if the vectors are not equal. - + Gets the remainder of each component of the [Vector2i] with the components of the given [Vector2i]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. [codeblock] @@ -150,7 +150,7 @@ - + Gets the remainder of each component of the [Vector2i] with the the given [int]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. [codeblock] @@ -160,7 +160,7 @@ - + Multiplies each component of the [Vector2i] by the components of the given [Vector2i]. [codeblock] @@ -170,7 +170,7 @@ - + Multiplies each component of the [Vector2i] by the given [float]. Returns a [Vector2]. [codeblock] @@ -180,14 +180,14 @@ - + Multiplies each component of the [Vector2i] by the given [int]. - + Adds each component of the [Vector2i] by the components of the given [Vector2i]. [codeblock] @@ -197,7 +197,7 @@ - + Subtracts each component of the [Vector2i] by the components of the given [Vector2i]. [codeblock] @@ -207,7 +207,7 @@ - + Divides each component of the [Vector2i] by the components of the given [Vector2i]. [codeblock] @@ -217,7 +217,7 @@ - + Divides each component of the [Vector2i] by the given [float]. Returns a [Vector2]. [codeblock] @@ -227,49 +227,49 @@ - + Divides each component of the [Vector2i] by the given [int]. - + Compares two [Vector2i] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. - + Compares two [Vector2i] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. - + Returns [code]true[/code] if the vectors are equal. - + Compares two [Vector2i] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. - + Compares two [Vector2i] vectors by first checking if the X value of the left vector is greater than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. - + Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], and [code]v[1][/code] is equivalent to [code]v.y[/code]. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index c181720a66..49aeb3e754 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -25,23 +25,23 @@ - + Constructs a [Vector3] as a copy of the given [Vector3]. - + Constructs a new [Vector3] from [Vector3i]. - - - + + + Returns a [Vector3] with the given components. @@ -56,24 +56,24 @@ - + Returns the unsigned minimum angle to the given vector, in radians. - - - - + + + + Returns the point at the given [code]t[/code] on the [url=https://en.wikipedia.org/wiki/B%C3%A9zier_curve]Bezier curve[/url] defined by this vector and the given [code]control_1[/code], [code]control_2[/code], and [code]end[/code] points. - + Returns the vector "bounced off" from a plane defined by the given normal. @@ -86,39 +86,39 @@ - - + + Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. - + Returns the cross product of this vector and [code]with[/code]. - - - - + + + + Performs a cubic interpolation between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. - + Returns the normalized vector pointing from this vector to [code]to[/code]. This is equivalent to using [code](b - a).normalized()[/code]. - + Returns the squared distance between this vector and [code]to[/code]. This method runs faster than [method distance_to], so prefer it if you need to compare vectors or need the squared distance for some formula. @@ -126,14 +126,14 @@ - + Returns the distance between this vector and [code]to[/code]. - + Returns the dot product of this vector and [code]with[/code]. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. The dot product will be [code]0[/code] for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees. @@ -155,7 +155,7 @@ - + Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. @@ -181,15 +181,15 @@ - - + + Returns the result of the linear interpolation between this vector and [code]to[/code] by amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. - + Returns the vector with a maximum length by limiting its length to [code]length[/code]. @@ -208,8 +208,8 @@ - - + + Returns a new vector moved toward [code]to[/code] by the fixed [code]delta[/code] amount. Will not go past the final value. @@ -222,7 +222,7 @@ - + @@ -233,43 +233,43 @@ - + Returns the outer product with [code]with[/code]. - + Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]mod[/code]. - + Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]modv[/code]'s components. - + Returns this vector projected onto the vector [code]b[/code]. - + Returns this vector reflected from a plane defined by the given normal. - - + + Rotates this vector around a given axis by [code]angle[/code] (in radians). The axis must be a normalized vector. @@ -288,16 +288,16 @@ - - + + Returns the signed angle to the given vector, in radians. The sign of the angle is positive in a counter-clockwise direction and negative in a clockwise direction when viewed from the side specified by the [code]axis[/code]. - - + + Returns the result of spherical linear interpolation between this vector and [code]to[/code], by amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. This method also handles interpolating the lengths if the input vectors have different lengths. For the special case of one or both input vectors having zero length, this method behaves like [method lerp]. @@ -305,14 +305,14 @@ - + Returns this vector slid along a plane defined by the given normal. - + Returns this vector with each component snapped to the nearest multiple of [code]step[/code]. This can also be used to round to an arbitrary number of decimals. @@ -370,7 +370,7 @@ - + Returns [code]true[/code] if the vectors are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -378,28 +378,28 @@ - + Inversely transforms (multiplies) the [Vector3] by the given [Basis] matrix. - + Inversely transforms (multiplies) the [Vector3] by the given [Quaternion]. - + Inversely transforms (multiplies) the [Vector3] by the given [Transform3D] transformation matrix. - + Multiplies each component of the [Vector3] by the components of the given [Vector3]. [codeblock] @@ -409,21 +409,21 @@ - + Multiplies each component of the [Vector3] by the given [float]. - + Multiplies each component of the [Vector3] by the given [int]. - + Adds each component of the [Vector3] by the components of the given [Vector3]. [codeblock] @@ -433,7 +433,7 @@ - + Subtracts each component of the [Vector3] by the components of the given [Vector3]. [codeblock] @@ -443,7 +443,7 @@ - + Divides each component of the [Vector3] by the components of the given [Vector3]. [codeblock] @@ -453,35 +453,35 @@ - + Divides each component of the [Vector3] by the given [float]. - + Divides each component of the [Vector3] by the given [int]. - + Compares two [Vector3] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. - + Compares two [Vector3] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. - + Returns [code]true[/code] if the vectors are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -489,21 +489,21 @@ - + Compares two [Vector3] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. - + Compares two [Vector3] vectors by first checking if the X value of the left vector is greater than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. - + Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], [code]v[1][/code] is equivalent to [code]v.y[/code], and [code]v[2][/code] is equivalent to [code]v.z[/code]. diff --git a/doc/classes/Vector3i.xml b/doc/classes/Vector3i.xml index ebb518792f..6c61bf8736 100644 --- a/doc/classes/Vector3i.xml +++ b/doc/classes/Vector3i.xml @@ -22,23 +22,23 @@ - + Constructs a [Vector3i] as a copy of the given [Vector3i]. - + Constructs a new [Vector3i] from [Vector3]. The floating point coordinates will be truncated. - - - + + + Returns a [Vector3i] with the given components. @@ -53,8 +53,8 @@ - - + + Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. @@ -140,14 +140,14 @@ - + Returns [code]true[/code] if the vectors are not equal. - + Gets the remainder of each component of the [Vector3i] with the components of the given [Vector3i]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. [codeblock] @@ -157,7 +157,7 @@ - + Gets the remainder of each component of the [Vector3i] with the the given [int]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. [codeblock] @@ -167,7 +167,7 @@ - + Multiplies each component of the [Vector3i] by the components of the given [Vector3i]. [codeblock] @@ -177,7 +177,7 @@ - + Multiplies each component of the [Vector3i] by the given [float]. Returns a [Vector3]. [codeblock] @@ -187,14 +187,14 @@ - + Multiplies each component of the [Vector3i] by the given [int]. - + Adds each component of the [Vector3i] by the components of the given [Vector3i]. [codeblock] @@ -204,7 +204,7 @@ - + Subtracts each component of the [Vector3i] by the components of the given [Vector3i]. [codeblock] @@ -214,7 +214,7 @@ - + Divides each component of the [Vector3i] by the components of the given [Vector3i]. [codeblock] @@ -224,7 +224,7 @@ - + Divides each component of the [Vector3i] by the given [float]. Returns a [Vector3]. [codeblock] @@ -234,49 +234,49 @@ - + Divides each component of the [Vector3i] by the given [int]. - + Compares two [Vector3i] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. - + Compares two [Vector3i] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. - + Returns [code]true[/code] if the vectors are equal. - + Compares two [Vector3i] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. - + Compares two [Vector3i] vectors by first checking if the X value of the left vector is greater than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. - + Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], [code]v[1][/code] is equivalent to [code]v.y[/code], and [code]v[2][/code] is equivalent to [code]v.z[/code]. diff --git a/doc/classes/Vector4.xml b/doc/classes/Vector4.xml index ee9d97019e..b5658f074a 100644 --- a/doc/classes/Vector4.xml +++ b/doc/classes/Vector4.xml @@ -19,24 +19,24 @@ - + Constructs a [Vector4] as a copy of the given [Vector4]. - + Constructs a new [Vector4] from [Vector4i]. - - - - + + + + Returns a [Vector4] with the given components. @@ -57,39 +57,39 @@ - - + + Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. - - - - + + + + Performs a cubic interpolation between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. - + Returns the normalized vector pointing from this vector to [code]to[/code]. This is equivalent to using [code](b - a).normalized()[/code]. - + Returns the distance between this vector and [code]to[/code]. - + Returns the dot product of this vector and [code]with[/code]. @@ -108,7 +108,7 @@ - + Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. @@ -133,8 +133,8 @@ - - + + Returns the result of the linear interpolation between this vector and [code]to[/code] by amount [code]weight[/code]. [code]weight[/code] is on the range of [code]0.0[/code] to [code]1.0[/code], representing the amount of interpolation. @@ -159,14 +159,14 @@ - + Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]mod[/code]. - + Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]modv[/code]'s components. @@ -185,7 +185,7 @@ - + Returns this vector with each component snapped to the nearest multiple of [code]step[/code]. This can also be used to round to an arbitrary number of decimals. @@ -231,7 +231,7 @@ - + Returns [code]true[/code] if the vectors are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -239,14 +239,14 @@ - + Inversely transforms (multiplies) the [Vector4] by the given [Projection] matrix. - + Multiplies each component of the [Vector4] by the components of the given [Vector4]. [codeblock] @@ -256,7 +256,7 @@ - + Multiplies each component of the [Vector4] by the given [float]. [codeblock] @@ -266,14 +266,14 @@ - + Multiplies each component of the [Vector4] by the given [int]. - + Adds each component of the [Vector4] by the components of the given [Vector4]. [codeblock] @@ -283,7 +283,7 @@ - + Subtracts each component of the [Vector4] by the components of the given [Vector4]. [codeblock] @@ -293,7 +293,7 @@ - + Divides each component of the [Vector4] by the components of the given [Vector4]. [codeblock] @@ -303,7 +303,7 @@ - + Divides each component of the [Vector4] by the given [float]. [codeblock] @@ -313,28 +313,28 @@ - + Divides each component of the [Vector4] by the given [int]. - + Compares two [Vector4] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. - + Compares two [Vector4] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. - + Returns [code]true[/code] if the vectors are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -342,21 +342,21 @@ - + Compares two [Vector4] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. - + Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], [code]v[1][/code] is equivalent to [code]v.y[/code], and [code]v[2][/code] is equivalent to [code]v.z[/code]. - + Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], [code]v[1][/code] is equivalent to [code]v.y[/code], [code]v[2][/code] is equivalent to [code]v.z[/code], and [code]v[3][/code] is equivalent to [code]v.w[/code]. diff --git a/doc/classes/Vector4i.xml b/doc/classes/Vector4i.xml index 6acce12e9f..9a36c3c4fa 100644 --- a/doc/classes/Vector4i.xml +++ b/doc/classes/Vector4i.xml @@ -14,22 +14,22 @@ - + - + - - - - + + + + @@ -42,8 +42,8 @@ - - + + @@ -100,103 +100,103 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/doc/classes/VelocityTracker3D.xml b/doc/classes/VelocityTracker3D.xml index 45ded446eb..56b60ba13c 100644 --- a/doc/classes/VelocityTracker3D.xml +++ b/doc/classes/VelocityTracker3D.xml @@ -14,13 +14,13 @@ - + - + diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 0808a8f1cf..f3db437b79 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -59,15 +59,15 @@ - + Returns the [enum PositionalShadowAtlasQuadrantSubdiv] of the specified quadrant. - - + + @@ -133,22 +133,22 @@ - - + + - + Returns [code]true[/code] if the viewport is currently embedding windows. - - + + @@ -160,15 +160,15 @@ - - + + Sets the number of subdivisions to use in the specified quadrant. A higher number of subdivisions allows you to have more shadows in the scene at once, but reduces the quality of the shadows. A good practice is to have quadrants with a varying number of subdivisions and to have as few subdivisions as possible. - + Moves the mouse pointer to the specified position in this [Viewport] using the coordinate system of this [Viewport]. @@ -302,7 +302,7 @@ - + Emitted when a Control node grabs keyboard focus. diff --git a/doc/classes/VisualInstance3D.xml b/doc/classes/VisualInstance3D.xml index 2468042850..3e23996173 100644 --- a/doc/classes/VisualInstance3D.xml +++ b/doc/classes/VisualInstance3D.xml @@ -34,7 +34,7 @@ - + Returns whether or not the specified layer of the [member layers] is enabled, given a [code]layer_number[/code] between 1 and 20. @@ -48,15 +48,15 @@ - + Sets the resource that is instantiated by this [VisualInstance3D], which changes how the engine handles the [VisualInstance3D] under the hood. Equivalent to [method RenderingServer.instance_set_base]. - - + + Based on [code]value[/code], enables or disables the specified layer in the [member layers], given a [code]layer_number[/code] between 1 and 20. diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index 64d901cd79..bf95a414f6 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -12,154 +12,154 @@ - - - - + + + + Adds the specified node to the shader. - - - + + + - - - - - + + + + + Returns [code]true[/code] if the specified nodes and ports can be connected together. - - - - - + + + + + Connects the specified nodes and ports. - - - - - + + + + + Connects the specified nodes and ports, even if they can't be connected. Such connection is invalid and will not function properly. - - - - - + + + + + Connects the specified nodes and ports. - - + + Returns the shader node instance with specified [code]type[/code] and [code]id[/code]. - + Returns the list of connected nodes with the specified type. - + Returns the list of all nodes in the shader with the specified type. - - + + Returns the position of the specified node within the shader graph. - + - + - - - - - + + + + + Returns [code]true[/code] if the specified node and port connection exist. - - + + Removes the specified node from the shader. - + - - - + + + Replaces the specified node with a node of new class type. - + Sets the mode of this shader. - - - + + + Sets the position of the specified node. diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml index 7220731a8a..6ab9c3717a 100644 --- a/doc/classes/VisualShaderNode.xml +++ b/doc/classes/VisualShaderNode.xml @@ -24,30 +24,30 @@ - + Returns the default value of the input [code]port[/code]. - + Removes the default value of the input [code]port[/code]. - + Sets the default input ports values using an [Array] of the form [code][index0, value0, index1, value1, ...][/code]. For example: [code][0, Vector3(0, 0, 0), 1, Vector3(0, 0, 0)][/code]. - - - + + + Sets the default value for the selected input [code]port[/code]. diff --git a/doc/classes/VisualShaderNodeCustom.xml b/doc/classes/VisualShaderNodeCustom.xml index 0a962a4aa4..8a2f607b75 100644 --- a/doc/classes/VisualShaderNodeCustom.xml +++ b/doc/classes/VisualShaderNodeCustom.xml @@ -25,10 +25,10 @@ - - - - + + + + Override this method to define the actual shader code of the associated custom node. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). The [code]input_vars[/code] and [code]output_vars[/code] arrays contain the string names of the various input and output variables, as defined by [code]_get_input_*[/code] and [code]_get_output_*[/code] virtual methods in this class. @@ -46,8 +46,8 @@ - - + + Override this method to add a shader code to the beginning of each shader function (once). The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). If there are multiple custom nodes of different types which use this feature the order of each insertion is undefined. @@ -57,7 +57,7 @@ - + Override this method to add shader code on top of the global shader, to define your own standard library of reusable methods, varyings, constants, uniforms, etc. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). Be careful with this functionality as it can cause name conflicts with other custom nodes, so be sure to give the defined entities unique names. @@ -74,7 +74,7 @@ - + Override this method to define the names of input ports of the associated custom node. The names are used both for the input slots in the editor and as identifiers in the shader code, and are passed in the [code]input_vars[/code] array in [method _get_code]. Defining this method is [b]optional[/b], but recommended. If not overridden, input ports are named as [code]"in" + str(port)[/code]. @@ -82,7 +82,7 @@ - + Override this method to define the returned type of each input port of the associated custom node (see [enum VisualShaderNode.PortType] for possible types). Defining this method is [b]optional[/b], but recommended. If not overridden, input ports will return the [constant VisualShaderNode.PORT_TYPE_SCALAR] type. @@ -104,7 +104,7 @@ - + Override this method to define the names of output ports of the associated custom node. The names are used both for the output slots in the editor and as identifiers in the shader code, and are passed in the [code]output_vars[/code] array in [method _get_code]. Defining this method is [b]optional[/b], but recommended. If not overridden, output ports are named as [code]"out" + str(port)[/code]. @@ -112,7 +112,7 @@ - + Override this method to define the returned type of each output port of the associated custom node (see [enum VisualShaderNode.PortType] for possible types). Defining this method is [b]optional[/b], but recommended. If not overridden, output ports will return the [constant VisualShaderNode.PORT_TYPE_SCALAR] type. @@ -127,8 +127,8 @@ - - + + Override this method to prevent the node to be visible in the member dialog for the certain [code]mode[/code] (see [enum Shader.Mode]) and/or [code]type[/code] (see [enum VisualShader.Type]). Defining this method is [b]optional[/b]. If not overridden, it's [code]true[/code]. diff --git a/doc/classes/VisualShaderNodeGroupBase.xml b/doc/classes/VisualShaderNodeGroupBase.xml index 1b724b00d6..9508aaba27 100644 --- a/doc/classes/VisualShaderNodeGroupBase.xml +++ b/doc/classes/VisualShaderNodeGroupBase.xml @@ -11,18 +11,18 @@ - - - + + + Adds an input port with the specified [code]type[/code] (see [enum VisualShaderNode.PortType]) and [code]name[/code]. - - - + + + Adds an output port with the specified [code]type[/code] (see [enum VisualShaderNode.PortType]) and [code]name[/code]. @@ -77,81 +77,81 @@ - + Returns [code]true[/code] if the specified input port exists. - + Returns [code]true[/code] if the specified output port exists. - + Returns [code]true[/code] if the specified port name does not override an existed port name and is valid within the shader. - + Removes the specified input port. - + Removes the specified output port. - - + + Renames the specified input port. - - + + Sets the specified input port's type (see [enum VisualShaderNode.PortType]). - + Defines all input ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_input_port]). - - + + Renames the specified output port. - - + + Sets the specified output port's type (see [enum VisualShaderNode.PortType]). - + Defines all output ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_output_port]). diff --git a/doc/classes/VoxelGI.xml b/doc/classes/VoxelGI.xml index d941185d33..ba4995a5fb 100644 --- a/doc/classes/VoxelGI.xml +++ b/doc/classes/VoxelGI.xml @@ -16,8 +16,8 @@ - - + + Bakes the effect from all [GeometryInstance3D]s marked with [constant GeometryInstance3D.GI_MODE_STATIC] and [Light3D]s marked with either [constant Light3D.BAKE_STATIC] or [constant Light3D.BAKE_DYNAMIC]. If [code]create_visual_debug[/code] is [code]true[/code], after baking the light, this will generate a [MultiMesh] that has a cube representing each solid cell with each cube colored to the cell's albedo color. This can be used to visualize the [VoxelGI]'s data and debug any issues that may be occurring. [b]Note:[/b] [method bake] works from the editor and in exported projects. This makes it suitable for procedurally generated or user-built levels. Baking a [VoxelGI] node generally takes from 5 to 20 seconds in most scenes. Reducing [member subdiv] can speed up baking. diff --git a/doc/classes/VoxelGIData.xml b/doc/classes/VoxelGIData.xml index 9198da4bc6..92b2e66e5a 100644 --- a/doc/classes/VoxelGIData.xml +++ b/doc/classes/VoxelGIData.xml @@ -13,13 +13,13 @@ - - - - - - - + + + + + + + diff --git a/doc/classes/Window.xml b/doc/classes/Window.xml index 84f3b6a4b1..3ceff8a6ed 100644 --- a/doc/classes/Window.xml +++ b/doc/classes/Window.xml @@ -30,7 +30,7 @@ - + Returns [code]true[/code] if the flag is set. @@ -49,8 +49,8 @@ - - + + Returns the [Color] at [code]name[/code] if the theme has [code]theme_type[/code]. See [method Control.get_theme_color] for more details. @@ -58,8 +58,8 @@ - - + + Returns the constant at [code]name[/code] if the theme has [code]theme_type[/code]. See [method Control.get_theme_color] for more details. @@ -88,8 +88,8 @@ - - + + Returns the [Font] at [code]name[/code] if the theme has [code]theme_type[/code]. See [method Control.get_theme_color] for more details. @@ -97,8 +97,8 @@ - - + + Returns the font size at [code]name[/code] if the theme has [code]theme_type[/code]. See [method Control.get_theme_color] for more details. @@ -106,8 +106,8 @@ - - + + Returns the icon at [code]name[/code] if the theme has [code]theme_type[/code]. See [method Control.get_theme_color] for more details. @@ -115,8 +115,8 @@ - - + + Returns the [StyleBox] at [code]name[/code] if the theme has [code]theme_type[/code]. See [method Control.get_theme_color] for more details. @@ -136,48 +136,48 @@ - - + + Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]theme_type[/code]. - - + + Returns [code]true[/code] if constant with [code]name[/code] is in [code]theme_type[/code]. - - + + Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]theme_type[/code]. - - + + Returns [code]true[/code] if font size with [code]name[/code] is in [code]theme_type[/code]. - - + + Returns [code]true[/code] if icon with [code]name[/code] is in [code]theme_type[/code]. - - + + Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]theme_type[/code]. @@ -220,7 +220,7 @@ - + Shows the [Window] and makes it transient (see [member transient]). If [code]rect[/code] is provided, it will be set as the [Window]'s size. Fails if called on the main window. @@ -228,7 +228,7 @@ - + Popups the [Window] at the center of the current screen, with optionally given minimum size. If the [Window] is embedded, it will be centered in the parent [Viewport] instead. @@ -236,8 +236,8 @@ - - + + Popups the [Window] centered inside its parent [Window]. [code]fallback_ratio[/code] determines the maximum size of the [Window], in relation to its parent. @@ -245,14 +245,14 @@ - + Popups the [Window] centered inside its parent [Window] and sets its size as a [code]ratio[/code] of parent's size. - + Popups the [Window] with a position shifted by parent [Window]'s position. If the [Window] is embedded, has the same effect as [method popup]. @@ -272,36 +272,36 @@ - - + + Sets a specified window flag. - + If [code]active[/code] is [code]true[/code], enables system's native IME (Input Method Editor). - + Moves IME to the given position. - + Sets layout direction and text writing direction. Right-to-left layouts are necessary for certain languages (e.g. Arabic and Hebrew). - + Enables font oversampling. This makes fonts look better when they are scaled up. @@ -407,7 +407,7 @@ - + Emitted when files are dragged from the OS file manager and dropped in the game window. The argument is a list of file paths. Note that this method only works with non-embedded windows, i.e. the main window and [Window]-derived nodes when [member Viewport.gui_embed_subwindows] is disabled in the main viewport. @@ -457,7 +457,7 @@ - + Emitted when the [Window] is currently focused and receives any input, passing the received event as an argument. diff --git a/doc/classes/WorkerThreadPool.xml b/doc/classes/WorkerThreadPool.xml index 4f614bdadb..fced54ae7f 100644 --- a/doc/classes/WorkerThreadPool.xml +++ b/doc/classes/WorkerThreadPool.xml @@ -9,49 +9,49 @@ - - - - - + + + + + - - - + + + - + - + - + - + - + diff --git a/doc/classes/X509Certificate.xml b/doc/classes/X509Certificate.xml index 581aba05e4..3082274123 100644 --- a/doc/classes/X509Certificate.xml +++ b/doc/classes/X509Certificate.xml @@ -12,14 +12,14 @@ - + Loads a certificate from [code]path[/code] ("*.crt" file). - + Saves a certificate to the given [code]path[/code] (should be a "*.crt" file). diff --git a/doc/classes/XMLParser.xml b/doc/classes/XMLParser.xml index 79ab33045f..ce58257817 100644 --- a/doc/classes/XMLParser.xml +++ b/doc/classes/XMLParser.xml @@ -17,14 +17,14 @@ - + Gets the name of the attribute specified by the index in [code]idx[/code] argument. - + Gets the value of the attribute specified by the index in [code]idx[/code] argument. @@ -37,14 +37,14 @@ - + Gets the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute. - + Gets the value of a certain attribute of the current element by name. This will return an empty [String] if the attribute is not found. @@ -75,7 +75,7 @@ - + Check whether the current element has a certain attribute. @@ -88,14 +88,14 @@ - + Opens an XML file for parsing. This returns an error code. - + Opens an XML raw buffer for parsing. This returns an error code. @@ -108,7 +108,7 @@ - + Moves the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. diff --git a/doc/classes/XRController3D.xml b/doc/classes/XRController3D.xml index ff4aec46e1..b1f498c8e3 100644 --- a/doc/classes/XRController3D.xml +++ b/doc/classes/XRController3D.xml @@ -15,7 +15,7 @@ - + Returns a [Vector2] for the input with the given [code]name[/code]. This is used for thumbsticks and thumbpads found on many controllers. @@ -28,14 +28,14 @@ - + Returns a numeric value for the input with the given [code]name[/code]. This is used for triggers and grip sensors. - + Returns [code]true[/code] if the button with the given [code]name[/code] is pressed. @@ -43,27 +43,27 @@ - + Emitted when a button on this controller is pressed. - + Emitted when a button on this controller is released. - - + + Emitted when a thumbstick or thumbpad on this controller is moved. - - + + Emitted when a trigger or similar input on this controller changes value. diff --git a/doc/classes/XRInterface.xml b/doc/classes/XRInterface.xml index 26b7699af2..1fd62fc8a6 100644 --- a/doc/classes/XRInterface.xml +++ b/doc/classes/XRInterface.xml @@ -71,26 +71,26 @@ - + Sets the active play area mode, will return [code]false[/code] if the mode can't be used with this interface. - + Call this to find out if a given play area mode is supported by this interface. - - - - - - + + + + + + Triggers a haptic pulse on a device associated with this interface. [code]action_name[/code] is the name of the action for this pulse. @@ -117,7 +117,7 @@ - + Emitted when the play area is changed. This can be a result of the player resetting the boundary or entering a new play area, the player changing the play area mode, the world scale changing or the player resetting their headset orientation. diff --git a/doc/classes/XRInterfaceExtension.xml b/doc/classes/XRInterfaceExtension.xml index 1642ae61f7..06ef18b534 100644 --- a/doc/classes/XRInterfaceExtension.xml +++ b/doc/classes/XRInterfaceExtension.xml @@ -59,10 +59,10 @@ - - - - + + + + Returns the projection matrix for the given view as a [PackedFloat64Array]. @@ -75,7 +75,7 @@ - + Returns a [PackedStringArray] with pose names configured by this interface. Note that user configuration can override this list. @@ -94,8 +94,8 @@ - - + + Returns a [Transform3D] for a given view. @@ -125,22 +125,22 @@ - + Informs the interface of an applicable system notification. - - + + Called after the XR [Viewport] draw logic has completed. - + Called if this is our primary [XRInterfaceExtension] before we start processing a [Viewport] for every active XR [Viewport], returns [code]true[/code] if that viewport should be rendered. An XR interface may return [code]false[/code] if the user has taken off their headset and we can pause rendering. @@ -159,33 +159,33 @@ - + Enables anchor detection on this interface if supported. - + Set the play area mode for this interface. - + Returns [code]true[/code] if this interface supports this play area mode. - - - - - - + + + + + + Triggers a haptic pulse to be emitted on the specified tracker. @@ -198,24 +198,24 @@ - - - - - - - - - - - + + + + + + + + + + + Blits our render results to screen optionally applying lens distortion. This can only be called while processing [code]_commit_views[/code]. - + Returns a valid [RID] for a texture to which we should render the current frame if supported by the interface. diff --git a/doc/classes/XRNode3D.xml b/doc/classes/XRNode3D.xml index bb9dccc2e0..21d0d20b3f 100644 --- a/doc/classes/XRNode3D.xml +++ b/doc/classes/XRNode3D.xml @@ -29,11 +29,11 @@ - - - - - + + + + + Triggers a haptic pulse on a device associated with this interface. [code]action_name[/code] is the name of the action for this pulse. diff --git a/doc/classes/XRPositionalTracker.xml b/doc/classes/XRPositionalTracker.xml index c146b27fcb..5f116de529 100644 --- a/doc/classes/XRPositionalTracker.xml +++ b/doc/classes/XRPositionalTracker.xml @@ -14,47 +14,47 @@ - + Returns an input for this tracker. It can return a boolean, float or [Vector2] value depending on whether the input is a button, trigger or thumbstick/thumbpad. - + Returns the current [XRPose] state object for the bound [code]pose[/code]. - + Returns [code]true[/code] if the bound [code]tracker[/code] is available and is currently tracking the bound [code]pose[/code]. - + Marks this pose as invalid, we don't clear the last reported state but it allows users to decide if trackers need to be hidden if we loose tracking or just remain at their last known position. - - + + Changes the value for the given input. This method is called by a [XRInterface] implementation and should not be used directly. - - - - - + + + + + Sets the transform, linear velocity, angular velocity and tracking confidence for the given pose. This method is called by a [XRInterface] implementation and should not be used directly. @@ -81,39 +81,39 @@ - + Emitted when a button on this tracker is pressed. Note that many XR runtimes allow other inputs to be mapped to buttons. - + Emitted when a button on this tracker is released. - - + + Emitted when a thumbstick or thumbpad on this tracker moves. - - + + Emitted when a trigger or similar input on this tracker changes value. - + Emitted when the state of a pose tracked by this tracker changes. - + Emitted when the profile of our tracker changes. diff --git a/doc/classes/XRServer.xml b/doc/classes/XRServer.xml index d3cb958cbc..3be252617c 100644 --- a/doc/classes/XRServer.xml +++ b/doc/classes/XRServer.xml @@ -12,22 +12,22 @@ - + Registers an [XRInterface] object. - + Registers a new [XRPositionalTracker] that tracks a spatial location in real space. - - + + This is an important function to understand correctly. AR and VR platforms all handle positioning slightly differently. For platforms that do not offer spatial tracking, our origin point (0,0,0) is the location of our HMD, but you have little control over the direction the player is facing in the real world. @@ -39,7 +39,7 @@ - + Finds an interface by its name. For instance, if your project uses capabilities of an AR/VR platform, you can find the interface for that platform by name and initialize it. @@ -52,7 +52,7 @@ - + Returns the interface registered at a given index in our list of interfaces. @@ -77,28 +77,28 @@ - + Returns the positional tracker with this name. - + Returns a dictionary of trackers for this type. - + Removes this interface. - + Removes this positional tracker. @@ -114,34 +114,34 @@ - + Emitted when a new interface has been added. - + Emitted when an interface is removed. - - + + Emitted when a new tracker has been added. If you don't use a fixed number of controllers or if you're using [XRAnchor3D]s for an AR solution, it is important to react to this signal to add the appropriate [XRController3D] or [XRAnchor3D] nodes related to this new tracker. - - + + Emitted when a tracker is removed. You should remove any [XRController3D] or [XRAnchor3D] points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one). - - + + Emitted when an existing tracker has been updated. This can happen if the user switches controllers. diff --git a/doc/classes/bool.xml b/doc/classes/bool.xml index 374b703636..d0ef664281 100644 --- a/doc/classes/bool.xml +++ b/doc/classes/bool.xml @@ -100,21 +100,21 @@ - + Constructs a [bool] as a copy of the given [bool]. - + Cast a [float] value to a boolean value, this method will return [code]false[/code] if [code]0.0[/code] is passed in, and [code]true[/code] for all other floats. - + Cast an [int] value to a boolean value, this method will return [code]false[/code] if [code]0[/code] is passed in, and [code]true[/code] for all other ints. @@ -123,28 +123,28 @@ - + Returns [code]true[/code] if two bools are different, i.e. one is [code]true[/code] and the other is [code]false[/code]. - + Returns [code]true[/code] if the left operand is [code]false[/code] and the right operand is [code]true[/code]. - + Returns [code]true[/code] if two bools are equal, i.e. both are [code]true[/code] or both are [code]false[/code]. - + Returns [code]true[/code] if the left operand is [code]true[/code] and the right operand is [code]false[/code]. diff --git a/doc/classes/float.xml b/doc/classes/float.xml index a7c6533ef5..9d685b9cd0 100644 --- a/doc/classes/float.xml +++ b/doc/classes/float.xml @@ -21,21 +21,21 @@ - + Constructs a [float] as a copy of the given [float]. - + Cast a [bool] value to a floating-point value, [code]float(true)[/code] will be equal to 1.0 and [code]float(false)[/code] will be equal to 0.0. - + Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to [code]1.0[/code]. @@ -44,21 +44,21 @@ - + Returns [code]true[/code] if two floats are different from each other. - + Returns [code]true[/code] if the integer has different value than the float. - + Multiplies each component of the [Color] by the given [float]. [codeblock] @@ -68,14 +68,14 @@ - + Multiplies each component of the [Quaternion] by the given [float]. This operation is not meaningful on its own, but it can be used as a part of a larger expression. - + Multiplies each component of the [Vector2] by the given [float]. [codeblock] @@ -85,7 +85,7 @@ - + Multiplies each component of the [Vector2i] by the given [float]. Returns a [Vector2]. [codeblock] @@ -95,14 +95,14 @@ - + Multiplies each component of the [Vector3] by the given [float]. - + Multiplies each component of the [Vector3i] by the given [float]. Returns a [Vector3]. [codeblock] @@ -112,115 +112,115 @@ - + - + - + Multiplies two [float]s. - + Multiplies a [float] and an [int]. The result is a [float]. - + - + - + Adds two floats. - + Adds a [float] and an [int]. The result is a [float]. - + Subtracts a float from a float. - + Subtracts an [int] from a [float]. The result is a [float]. - + Divides two floats. - + Divides a [float] by an [int]. The result is a [float]. - + Returns [code]true[/code] the left float is less than the right one. - + Returns [code]true[/code] if this [float] is less than the given [int]. - + Returns [code]true[/code] the left integer is less than or equal to the right one. - + Returns [code]true[/code] if this [float] is less than or equal to the given [int]. - + Returns [code]true[/code] if both floats are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method @GlobalScope.is_equal_approx] or [method @GlobalScope.is_zero_approx] instead, which are more reliable. @@ -228,35 +228,35 @@ - + Returns [code]true[/code] if the [float] and the given [int] are equal. - + Returns [code]true[/code] the left float is greater than the right one. - + Returns [code]true[/code] if this [float] is greater than the given [int]. - + Returns [code]true[/code] the left float is greater than or equal to the right one. - + Returns [code]true[/code] if this [float] is greater than or equal to the given [int]. diff --git a/doc/classes/int.xml b/doc/classes/int.xml index 6b492ca923..98c200c114 100644 --- a/doc/classes/int.xml +++ b/doc/classes/int.xml @@ -47,21 +47,21 @@ - + Constructs an [int] as a copy of the given [int]. - + Cast a [bool] value to an integer value, [code]int(true)[/code] will be equals to 1 and [code]int(false)[/code] will be equals to 0. - + Cast a float value to an integer value, this method simply removes the number fractions (i.e. rounds [code]from[/code] towards zero), so for example [code]int(2.7)[/code] will be equals to 2, [code]int(0.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2. This operation is also called truncation. @@ -70,21 +70,21 @@ - + Returns [code]true[/code] if operands are different from each other. - + Returns [code]true[/code] if operands are different from each other. - + Returns the remainder after dividing two integers. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. [codeblock] @@ -96,7 +96,7 @@ - + Returns the result of bitwise [code]AND[/code] operation for two integers. [codeblock] @@ -114,21 +114,21 @@ - + Multiplies each component of the [Color] by the given [int]. - + Multiplies each component of the [Quaternion] by the given [int]. This operation is not meaningful on its own, but it can be used as a part of a larger expression. - + Multiplies each component of the [Vector2] by the given [int]. [codeblock] @@ -138,101 +138,101 @@ - + Multiplies each component of the [Vector2i] by the given [int]. - + Multiplies each component of the [Vector3] by the given [int]. - + Multiplies each component of the [Vector3i] by the given [int]. - + - + - + Multiplies an [int] and a [float]. The result is a [float]. - + Multiplies two [int]s. - + - + - + Adds Unicode character with code [int] to the [String]. - + Adds an [int] and a [float]. The result is a [float]. - + Adds two integers. - + Subtracts a [float] from an [int]. The result is a [float]. - + Subtracts two integers. - + Divides an [int] by a [float]. The result is a [float]. [codeblock] @@ -242,7 +242,7 @@ - + Divides two integers. The decimal part of the result is discarded (truncated). [codeblock] @@ -253,21 +253,21 @@ - + Returns [code]true[/code] if this [int] is less than the given [float]. - + Returns [code]true[/code] the left integer is less than the right one. - + Performs bitwise shift left operation on the integer. Effectively the same as multiplying by a power of 2. [codeblock] @@ -278,63 +278,63 @@ - + Returns [code]true[/code] if this [int] is less than or equal to the given [float]. - + Returns [code]true[/code] the left integer is less than or equal to the right one. - + Returns [code]true[/code] if the integer is equal to the given [float]. - + Returns [code]true[/code] if both integers are equal. - + Returns [code]true[/code] if this [int] is greater than the given [float]. - + Returns [code]true[/code] the left integer is greater than the right one. - + Returns [code]true[/code] if this [int] is greater than or equal to the given [float]. - + Returns [code]true[/code] the left integer is greater than or equal to the right one. - + Performs bitwise shift right operation on the integer. Effectively the same as dividing by a power of 2. [codeblock] @@ -345,7 +345,7 @@ - + Returns the result of bitwise [code]XOR[/code] operation for two integers. [codeblock] @@ -368,7 +368,7 @@ - + Returns the result of bitwise [code]OR[/code] operation for two integers. [codeblock] -- cgit v1.2.3