From 6a99685820493e22ec40aa03e97339a4379d0562 Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 6 May 2023 03:19:18 +0000 Subject: [PATCH] classref: Sync with current master branch (9ce3194) --- classes/class_@gdscript.rst | 26 +- classes/class_@globalscope.rst | 44 +- classes/class_aabb.rst | 6 +- classes/class_aescontext.rst | 32 +- classes/class_animatablebody2d.rst | 2 +- classes/class_animatablebody3d.rst | 2 +- classes/class_animation.rst | 56 + classes/class_animationnode.rst | 92 +- classes/class_animationnodestatemachine.rst | 85 +- classes/class_animationplayer.rst | 2 +- classes/class_area2d.rst | 10 +- classes/class_area3d.rst | 12 +- classes/class_array.rst | 16 +- classes/class_astargrid2d.rst | 61 +- classes/class_basebutton.rst | 2 + classes/class_basematerial3d.rst | 2 +- classes/class_button.rst | 16 +- classes/class_buttongroup.rst | 32 +- classes/class_callable.rst | 18 +- classes/class_canvasitem.rst | 10 +- classes/class_characterbody2d.rst | 20 +- classes/class_characterbody3d.rst | 16 +- classes/class_checkbox.rst | 2 + classes/class_collisionpolygon2d.rst | 14 +- classes/class_collisionpolygon3d.rst | 10 +- classes/class_collisionshape2d.rst | 2 +- classes/class_collisionshape3d.rst | 2 +- classes/class_colorpicker.rst | 88 +- classes/class_compressedcubemap.rst | 6 +- classes/class_compressedcubemaparray.rst | 6 +- classes/class_compressedtexture2d.rst | 6 +- classes/class_compressedtexture2darray.rst | 6 +- classes/class_compressedtexturelayered.rst | 14 +- classes/class_concavepolygonshape2d.rst | 14 +- classes/class_concavepolygonshape3d.rst | 16 +- classes/class_conetwistjoint3d.rst | 8 +- classes/class_control.rst | 32 +- classes/class_convexpolygonshape2d.rst | 16 +- classes/class_convexpolygonshape3d.rst | 10 +- classes/class_cpuparticles3d.rst | 2 +- classes/class_crypto.rst | 8 +- classes/class_csgshape3d.rst | 2 +- classes/class_curve3d.rst | 2 +- classes/class_dictionary.rst | 2 - classes/class_diraccess.rst | 2 +- classes/class_displayserver.rst | 94 +- classes/class_dtlsserver.rst | 12 +- classes/class_editorexportplatform.rst | 2 + classes/class_editorexportplatformandroid.rst | 2708 +++++++++++++++++ classes/class_editorexportplatformios.rst | 828 +++++ .../class_editorexportplatformlinuxbsd.rst | 292 ++ classes/class_editorexportplatformmacos.rst | 1304 ++++++++ ...n.rst => class_editorexportplatformpc.rst} | 14 +- classes/class_editorexportplatformweb.rst | 342 +++ classes/class_editorexportplatformwindows.rst | 572 ++++ classes/class_editorexportplugin.rst | 50 + classes/class_editorfiledialog.rst | 2 +- classes/class_editorinterface.rst | 89 +- classes/class_editorpaths.rst | 6 +- classes/class_editorplugin.rst | 2 +- .../class_editorresourceconversionplugin.rst | 4 +- classes/class_editorscript.rst | 8 +- classes/class_editorsettings.rst | 54 +- classes/class_editorundoredomanager.rst | 4 + classes/class_editorvcsinterface.rst | 12 +- classes/class_enetpacketpeer.rst | 2 +- classes/class_engine.rst | 2 +- classes/class_environment.rst | 2 +- classes/class_expression.rst | 7 + classes/class_fileaccess.rst | 8 + classes/class_filedialog.rst | 4 +- classes/class_filesystemdock.rst | 47 +- classes/class_font.rst | 14 + classes/class_fontfile.rst | 14 + classes/class_fontvariation.rst | 15 +- classes/class_gltfcollider.rst | 257 ++ classes/class_gltfnode.rst | 50 +- classes/class_gltfphysicsbody.rst | 219 ++ classes/class_gltfstate.rst | 103 +- classes/class_gradient.rst | 2 + classes/class_graphedit.rst | 8 +- classes/class_graphnode.rst | 4 +- classes/class_hmaccontext.rst | 12 +- classes/class_hslider.rst | 14 + classes/class_image.rst | 18 +- classes/class_imagetexture.rst | 2 +- classes/class_immediatemesh.rst | 30 +- classes/class_input.rst | 4 +- classes/class_inputeventfromwindow.rst | 13 +- classes/class_inputeventgesture.rst | 7 + classes/class_inputeventmagnifygesture.rst | 13 +- classes/class_inputeventpangesture.rst | 13 +- classes/class_inputeventshortcut.rst | 13 +- classes/class_int.rst | 186 +- classes/class_itemlist.rst | 47 + classes/class_lineedit.rst | 22 +- classes/class_marker2d.rst | 2 +- .../class_meshconvexdecompositionsettings.rst | 322 ++ classes/class_meshdatatool.rst | 4 +- classes/class_meshinstance3d.rst | 54 +- classes/class_multiplayerpeerextension.rst | 44 +- classes/class_multiplayersynchronizer.rst | 2 +- classes/class_navigationagent2d.rst | 112 +- classes/class_navigationagent3d.rst | 116 +- classes/class_navigationlink2d.rst | 4 +- classes/class_navigationlink3d.rst | 4 +- classes/class_navigationserver2d.rst | 2 +- classes/class_node.rst | 49 +- classes/class_node3d.rst | 6 +- classes/class_nodepath.rst | 2 +- classes/class_noise.rst | 70 +- classes/class_noisetexture3d.rst | 228 ++ classes/class_object.rst | 4 +- classes/class_openxraction.rst | 2 +- classes/class_openxrinterface.rst | 25 +- classes/class_optionbutton.rst | 21 + classes/class_os.rst | 48 +- classes/class_packedbytearray.rst | 16 +- classes/class_packetpeerudp.rst | 4 +- classes/class_particleprocessmaterial.rst | 18 +- classes/class_physicsdirectbodystate2d.rst | 16 +- ...lass_physicsdirectbodystate2dextension.rst | 16 + classes/class_physicsdirectbodystate3d.rst | 14 + ...lass_physicsdirectbodystate3dextension.rst | 16 + classes/class_physicsdirectspacestate2d.rst | 28 +- classes/class_physicsdirectspacestate3d.rst | 28 +- ...ass_physicsdirectspacestate3dextension.rst | 4 +- classes/class_physicsserver3d.rst | 28 +- classes/class_physicsserver3dextension.rst | 764 ++--- classes/class_polygon2d.rst | 12 +- classes/class_popupmenu.rst | 46 +- classes/class_projectsettings.rst | 366 ++- classes/class_quaternion.rst | 12 +- classes/class_refcounted.rst | 2 +- classes/class_renderingdevice.rst | 18 +- classes/class_renderingserver.rst | 144 +- classes/class_resource.rst | 2 +- classes/class_ribbontrailmesh.rst | 48 +- classes/class_richtextlabel.rst | 4 +- classes/class_rigidbody2d.rst | 2 +- classes/class_rigidbody3d.rst | 2 +- classes/class_scenetree.rst | 6 +- classes/class_scriptlanguageextension.rst | 2 +- classes/class_shape3d.rst | 2 +- classes/class_shapecast2d.rst | 2 +- classes/class_shapecast3d.rst | 2 +- classes/class_skeleton3d.rst | 2 +- classes/class_skeletonik3d.rst | 2 +- .../class_skeletonmodification2dfabrik.rst | 2 +- .../class_skeletonmodification2dlookat.rst | 2 +- ...ss_skeletonmodification2dphysicalbones.rst | 2 +- classes/class_staticbody2d.rst | 4 +- classes/class_staticbody3d.rst | 6 +- classes/class_streampeer.rst | 8 +- classes/class_string.rst | 63 +- classes/class_stringname.rst | 59 + classes/class_styleboxflat.rst | 8 +- classes/class_surfacetool.rst | 2 + classes/class_syntaxhighlighter.rst | 4 +- classes/class_tabbar.rst | 104 +- classes/class_tabcontainer.rst | 106 + classes/class_textedit.rst | 27 +- classes/class_textserver.rst | 28 +- classes/class_textserverextension.rst | 16 + classes/class_texture3d.rst | 2 +- classes/class_texturelayered.rst | 4 +- classes/class_theme.rst | 2 +- classes/class_thread.rst | 4 +- classes/class_tilemap.rst | 20 +- classes/class_tileset.rst | 10 +- classes/class_timer.rst | 4 +- classes/class_transform2d.rst | 44 +- classes/class_transform3d.rst | 26 +- classes/class_translationserver.rst | 2 +- classes/class_tree.rst | 287 +- classes/class_treeitem.rst | 44 +- classes/class_tubetrailmesh.rst | 44 +- classes/class_tween.rst | 20 +- classes/class_udpserver.rst | 6 +- classes/class_undoredo.rst | 34 +- classes/class_upnp.rst | 4 +- classes/class_vector2.rst | 14 +- classes/class_vector2i.rst | 4 +- classes/class_vector3.rst | 8 +- classes/class_vector3i.rst | 4 +- classes/class_vector4.rst | 20 +- classes/class_vector4i.rst | 6 +- classes/class_vehiclewheel3d.rst | 4 +- classes/class_viewport.rst | 14 +- classes/class_visualinstance3d.rst | 2 +- ...class_visualshadernodetextureparameter.rst | 2 +- classes/class_vslider.rst | 14 + classes/class_webrtcmultiplayerpeer.rst | 4 +- classes/class_webrtcpeerconnection.rst | 10 +- classes/class_websocketmultiplayerpeer.rst | 2 +- classes/class_webxrinterface.rst | 54 + classes/class_window.rst | 48 +- classes/class_xrinterface.rst | 24 +- classes/class_xrinterfaceextension.rst | 18 +- classes/class_xrserver.rst | 31 +- classes/index.rst | 73 +- 201 files changed, 10825 insertions(+), 1661 deletions(-) create mode 100644 classes/class_editorexportplatformandroid.rst create mode 100644 classes/class_editorexportplatformios.rst create mode 100644 classes/class_editorexportplatformlinuxbsd.rst create mode 100644 classes/class_editorexportplatformmacos.rst rename classes/{class_animationtrackeditplugin.rst => class_editorexportplatformpc.rst} (66%) create mode 100644 classes/class_editorexportplatformweb.rst create mode 100644 classes/class_editorexportplatformwindows.rst create mode 100644 classes/class_gltfcollider.rst create mode 100644 classes/class_gltfphysicsbody.rst create mode 100644 classes/class_meshconvexdecompositionsettings.rst create mode 100644 classes/class_noisetexture3d.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index f695dbeb8be..3145afe0f0e 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -133,7 +133,7 @@ Mark the following property as exported (editable in the Inspector dock and save @export var string = "" @export var int_number = 5 @export var float_number: float = 5 - @export var image : Image + @export var image: Image .. rst-class:: classref-item-separator @@ -173,7 +173,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_COLOR_NO_ALPHA` to add subgroups within groups. @@ -662,6 +662,18 @@ The order of ``mode``, ``sync`` and ``transfer_mode`` does not matter and all ar ---- +.. _class_@GDScript_annotation_@static_unload: + +.. rst-class:: classref-annotation + +**@static_unload** **(** **)** + +Make a script with static variables to not persist after all references are lost. If the script is loaded again the static variables will revert to their default values. + +.. rst-class:: classref-item-separator + +---- + .. _class_@GDScript_annotation_@tool: .. rst-class:: classref-annotation @@ -712,7 +724,7 @@ Method Descriptions :ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** -Returns a :ref:`Color` constructed from red (``r8``), green (``g8``), blue (``b8``), and optionally alpha (``a8``) integer channels, each divided by ``255.0`` for their final value. +Returns a :ref:`Color` constructed from red (``r8``), green (``g8``), blue (``b8``), and optionally alpha (``a8``) integer channels, each divided by ``255.0`` for their final value. Using :ref:`Color8` instead of the standard :ref:`Color` constructor is useful when you need to match exact color values in an :ref:`Image`. :: @@ -720,6 +732,8 @@ Returns a :ref:`Color` constructed from red (``r8``), green (``g8`` var dark_blue = Color8(0, 0, 51) # Same as Color(0, 0, 0.2). var my_color = Color8(306, 255, 0, 102) # Same as Color(1.2, 1, 0, 0.4). +\ **Note:** Due to the lower precision of :ref:`Color8` compared to the standard :ref:`Color` constructor, a color created with :ref:`Color8` will generally not be equal to the same color created with the standard :ref:`Color` constructor. Use :ref:`Color.is_equal_approx` for comparisons to avoid issues with floating-point precision error. + .. rst-class:: classref-item-separator ---- @@ -1034,8 +1048,8 @@ To iterate over an :ref:`Array` backwards, use: :: var array = [3, 6, 9] - for i in range(array.size(), 0, -1): - print(array[i - 1]) + for i in range(array.size() - 1, -1, -1): + print(array[i]) Output: diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 87e5bfa09fe..b13e5f163e9 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -3758,7 +3758,7 @@ The property is shown in the :ref:`EditorInspector` (defa :ref:`PropertyUsageFlags` **PROPERTY_USAGE_INTERNAL** = ``8`` - +The property is excluded from the class reference. .. _class_@GlobalScope_constant_PROPERTY_USAGE_CHECKABLE: @@ -5904,7 +5904,7 @@ Linearly interpolates between two values by the factor defined in ``weight``. To :: - lerp(0, 4, 0.75) # Returns 3.0 + lerpf(0, 4, 0.75) # Returns 3.0 See also :ref:`inverse_lerp` which performs the reverse of this operation. To perform eased interpolation with :ref:`lerp`, combine it with :ref:`ease` or :ref:`smoothstep`. @@ -5939,9 +5939,9 @@ Converts from linear energy to decibels (audio). This can be used to implement v :ref:`float` **log** **(** :ref:`float` x **)** -Returns the natural logarithm of ``x``. This is the amount of time needed to reach a certain level of continuous growth. +Returns the `natural logarithm `__ of ``x`` (base `[i]e[/i] `__, with *e* being approximately 2.71828). This is the amount of time needed to reach a certain level of continuous growth. -\ **Note:** This is not the same as the "log" function on most calculators, which uses a base 10 logarithm. +\ **Note:** This is not the same as the "log" function on most calculators, which uses a base 10 logarithm. To use base 10 logarithm, use ``log(x) / log(10)``. :: @@ -6208,25 +6208,33 @@ Converts one or more arguments of any type to string in the best way possible an void **print_rich** **(** ... **)** |vararg| -Converts one or more arguments of any type to string in the best way possible and prints them to the console. The following BBCode tags are supported: b, i, u, s, indent, code, url, center, right, color, bgcolor, fgcolor. Color tags only support named colors such as ``red``, *not* hexadecimal color codes. Unsupported tags will be left as-is in standard output. +Converts one or more arguments of any type to string in the best way possible and prints them to the console. + +The following BBCode tags are supported: ``b``, ``i``, ``u``, ``s``, ``indent``, ``code``, ``url``, ``center``, ``right``, ``color``, ``bgcolor``, ``fgcolor``. -When printing to standard output, the supported subset of BBCode is converted to ANSI escape codes for the terminal emulator to display. Displaying ANSI escape codes is currently only supported on Linux and macOS. Support for ANSI escape codes may vary across terminal emulators, especially for italic and strikethrough. +Color tags only support the following named colors: ``black``, ``red``, ``green``, ``yellow``, ``blue``, ``magenta``, ``pink``, ``purple``, ``cyan``, ``white``, ``orange``, ``gray``. Hexadecimal color codes are not supported. + +URL tags only support URLs wrapped by an URL tag, not URLs with a different title. + +When printing to standard output, the supported subset of BBCode is converted to ANSI escape codes for the terminal emulator to display. Support for ANSI escape codes varies across terminal emulators, especially for italic and strikethrough. In standard output, ``code`` is represented with faint text but without any font change. Unsupported tags are left as-is in standard output. .. tabs:: .. code-tab:: gdscript - print_rich("[code][b]Hello world![/b][/code]") # Prints out: [b]Hello world![/b] + print_rich("[color=green][b]Hello world![/b][/color]") # Prints out "Hello world!" in green with a bold font .. code-tab:: csharp - GD.PrintRich("[code][b]Hello world![/b][/code]"); // Prints out: [b]Hello world![/b] + GD.PrintRich("[color=green][b]Hello world![/b][/color]"); // Prints out "Hello world!" in green with a bold font \ **Note:** Consider using :ref:`push_error` and :ref:`push_warning` to print error and warning messages instead of :ref:`print` or :ref:`print_rich`. This distinguishes them from print messages used for debugging purposes, while also displaying a stack trace when an error or warning is printed. +\ **Note:** On Windows, only Windows 10 and later correctly displays ANSI escape codes in standard output. + .. rst-class:: classref-item-separator ---- @@ -6735,9 +6743,9 @@ Returns ``-1.0`` if ``x`` is negative, ``1.0`` if ``x`` is positive, and ``0.0`` :: - sign(-6.5) # Returns -1.0 - sign(0.0) # Returns 0.0 - sign(6.5) # Returns 1.0 + signf(-6.5) # Returns -1.0 + signf(0.0) # Returns 0.0 + signf(6.5) # Returns 1.0 .. rst-class:: classref-item-separator @@ -6753,9 +6761,9 @@ Returns ``-1`` if ``x`` is negative, ``1`` if ``x`` is positive, and ``0`` if if :: - sign(-6) # Returns -1 - sign(0) # Returns 0 - sign(6) # Returns 1 + signi(-6) # Returns -1 + signi(0) # Returns 0 + signi(6) # Returns 1 .. rst-class:: classref-item-separator @@ -6859,8 +6867,8 @@ A type-safe version of :ref:`snapped`, return :: - snapped(32.0, 2.5) # Returns 32.5 - snapped(3.14159, 0.01) # Returns 3.14 + snappedf(32.0, 2.5) # Returns 32.5 + snappedf(3.14159, 0.01) # Returns 3.14 .. rst-class:: classref-item-separator @@ -6878,8 +6886,8 @@ A type-safe version of :ref:`snapped`, return :: - snapped(53, 16) # Returns 48 - snapped(4096, 100) # Returns 4100 + snappedi(53, 16) # Returns 48 + snappedi(4096, 100) # Returns 4100 .. rst-class:: classref-item-separator diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index f6746b71dcb..3dce76104d7 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -502,7 +502,7 @@ Returns ``true`` if the **AABB** is on both sides of a plane. :ref:`Variant` **intersects_ray** **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** |const| -Returns ``true`` if the given ray intersects with this **AABB**. Ray length is infinite. +Returns the point of intersection of the given ray with this **AABB** or ``null`` if there is no intersection. Ray length is infinite. .. rst-class:: classref-item-separator @@ -514,7 +514,7 @@ Returns ``true`` if the given ray intersects with this **AABB**. Ray length is i :ref:`Variant` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** |const| -Returns ``true`` if the **AABB** intersects the line segment between ``from`` and ``to``. +Returns the point of intersection between ``from`` and ``to`` with this **AABB** or ``null`` if there is no intersection. .. rst-class:: classref-item-separator @@ -567,7 +567,7 @@ Operator Descriptions :ref:`bool` **operator !=** **(** :ref:`AABB` right **)** -Returns ``true`` if the vectors are not equal. +Returns ``true`` if the AABBs are not equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx` instead, which is more reliable. diff --git a/classes/class_aescontext.rst b/classes/class_aescontext.rst index 9a2f1fdc8a4..88c84a081f7 100644 --- a/classes/class_aescontext.rst +++ b/classes/class_aescontext.rst @@ -34,27 +34,27 @@ This class provides access to AES encryption/decryption of raw data. Both AES-EC var key = "My secret key!!!" # Key must be either 16 or 32 bytes. var data = "My secret text!!" # Data size must be multiple of 16 bytes, apply padding if needed. # Encrypt ECB - aes.start(AESContext.MODE_ECB_ENCRYPT, key.to_utf8()) - var encrypted = aes.update(data.to_utf8()) + aes.start(AESContext.MODE_ECB_ENCRYPT, key.to_utf8_buffer()) + var encrypted = aes.update(data.to_utf8_buffer()) aes.finish() # Decrypt ECB - aes.start(AESContext.MODE_ECB_DECRYPT, key.to_utf8()) + aes.start(AESContext.MODE_ECB_DECRYPT, key.to_utf8_buffer()) var decrypted = aes.update(encrypted) aes.finish() # Check ECB - assert(decrypted == data.to_utf8()) + assert(decrypted == data.to_utf8_buffer()) var iv = "My secret iv!!!!" # IV must be of exactly 16 bytes. # Encrypt CBC - aes.start(AESContext.MODE_CBC_ENCRYPT, key.to_utf8(), iv.to_utf8()) - encrypted = aes.update(data.to_utf8()) + aes.start(AESContext.MODE_CBC_ENCRYPT, key.to_utf8_buffer(), iv.to_utf8_buffer()) + encrypted = aes.update(data.to_utf8_buffer()) aes.finish() # Decrypt CBC - aes.start(AESContext.MODE_CBC_DECRYPT, key.to_utf8(), iv.to_utf8()) + aes.start(AESContext.MODE_CBC_DECRYPT, key.to_utf8_buffer(), iv.to_utf8_buffer()) decrypted = aes.update(encrypted) aes.finish() # Check CBC - assert(decrypted == data.to_utf8()) + assert(decrypted == data.to_utf8_buffer()) .. code-tab:: csharp @@ -70,27 +70,27 @@ This class provides access to AES encryption/decryption of raw data. Both AES-EC string key = "My secret key!!!"; // Key must be either 16 or 32 bytes. string data = "My secret text!!"; // Data size must be multiple of 16 bytes, apply padding if needed. // Encrypt ECB - _aes.Start(AesContext.Mode.EcbEncrypt, key.ToUtf8()); - byte[] encrypted = _aes.Update(data.ToUtf8()); + _aes.Start(AesContext.Mode.EcbEncrypt, key.ToUtf8Buffer()); + byte[] encrypted = _aes.Update(data.ToUtf8Buffer()); _aes.Finish(); // Decrypt ECB - _aes.Start(AesContext.Mode.EcbDecrypt, key.ToUtf8()); + _aes.Start(AesContext.Mode.EcbDecrypt, key.ToUtf8Buffer()); byte[] decrypted = _aes.Update(encrypted); _aes.Finish(); // Check ECB - Debug.Assert(decrypted == data.ToUtf8()); + Debug.Assert(decrypted == data.ToUtf8Buffer()); string iv = "My secret iv!!!!"; // IV must be of exactly 16 bytes. // Encrypt CBC - _aes.Start(AesContext.Mode.EcbEncrypt, key.ToUtf8(), iv.ToUtf8()); - encrypted = _aes.Update(data.ToUtf8()); + _aes.Start(AesContext.Mode.EcbEncrypt, key.ToUtf8Buffer(), iv.ToUtf8Buffer()); + encrypted = _aes.Update(data.ToUtf8Buffer()); _aes.Finish(); // Decrypt CBC - _aes.Start(AesContext.Mode.EcbDecrypt, key.ToUtf8(), iv.ToUtf8()); + _aes.Start(AesContext.Mode.EcbDecrypt, key.ToUtf8Buffer(), iv.ToUtf8Buffer()); decrypted = _aes.Update(encrypted); _aes.Finish(); // Check CBC - Debug.Assert(decrypted == data.ToUtf8()); + Debug.Assert(decrypted == data.ToUtf8Buffer()); } } diff --git a/classes/class_animatablebody2d.rst b/classes/class_animatablebody2d.rst index 11264de808f..8d9003e0f66 100644 --- a/classes/class_animatablebody2d.rst +++ b/classes/class_animatablebody2d.rst @@ -12,7 +12,7 @@ AnimatableBody2D **Inherits:** :ref:`StaticBody2D` **<** :ref:`PhysicsBody2D` **<** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -Physics body for 2D physics which moves only by script or animation. Useful for moving platforms and doors. +Physics body for 2D physics which moves only by script or animation (while affecting other bodies on its path). Useful for moving platforms and doors. .. rst-class:: classref-introduction-group diff --git a/classes/class_animatablebody3d.rst b/classes/class_animatablebody3d.rst index 347d2a310aa..563e7eb7a85 100644 --- a/classes/class_animatablebody3d.rst +++ b/classes/class_animatablebody3d.rst @@ -12,7 +12,7 @@ AnimatableBody3D **Inherits:** :ref:`StaticBody3D` **<** :ref:`PhysicsBody3D` **<** :ref:`CollisionObject3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -Physics body for 3D physics which moves only by script or animation. Useful for moving platforms and doors. +Physics body for 3D physics which moves only by script or animation (while affecting other bodies on its path). Useful for moving platforms and doors. .. rst-class:: classref-introduction-group diff --git a/classes/class_animation.rst b/classes/class_animation.rst index b0d9235d3d7..1df8c3d2055 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -126,6 +126,8 @@ Methods +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`blend_shape_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`float` amount **)** | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`blend_shape_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| | + +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`compress` **(** :ref:`int` page_size=8192, :ref:`int` fps=120, :ref:`float` split_tolerance=4.0 **)** | @@ -142,12 +144,18 @@ Methods +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`position_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Vector3` position **)** | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`position_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| | + +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_track` **(** :ref:`int` track_idx **)** | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rotation_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Quaternion` rotation **)** | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`rotation_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| | + +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`scale_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Vector3` scale **)** | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`scale_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| | + +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`track_find_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`FindMode` find_mode=0 **)** |const| | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` track_idx **)** |const| | @@ -825,6 +833,18 @@ Inserts a key in a given blend shape track. Returns the key index. ---- +.. _class_Animation_method_blend_shape_track_interpolate: + +.. rst-class:: classref-method + +:ref:`float` **blend_shape_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| + +Returns the interpolated blend shape value at the given time (in seconds). The ``track_idx`` must be the index of a blend shape track. + +.. rst-class:: classref-item-separator + +---- + .. _class_Animation_method_clear: .. rst-class:: classref-method @@ -923,6 +943,18 @@ Inserts a key in a given 3D position track. Returns the key index. ---- +.. _class_Animation_method_position_track_interpolate: + +.. rst-class:: classref-method + +:ref:`Vector3` **position_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| + +Returns the interpolated position value at the given time (in seconds). The ``track_idx`` must be the index of a 3D position track. + +.. rst-class:: classref-item-separator + +---- + .. _class_Animation_method_remove_track: .. rst-class:: classref-method @@ -947,6 +979,18 @@ Inserts a key in a given 3D rotation track. Returns the key index. ---- +.. _class_Animation_method_rotation_track_interpolate: + +.. rst-class:: classref-method + +:ref:`Quaternion` **rotation_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| + +Returns the interpolated rotation value at the given time (in seconds). The ``track_idx`` must be the index of a 3D rotation track. + +.. rst-class:: classref-item-separator + +---- + .. _class_Animation_method_scale_track_insert_key: .. rst-class:: classref-method @@ -959,6 +1003,18 @@ Inserts a key in a given 3D scale track. Returns the key index. ---- +.. _class_Animation_method_scale_track_interpolate: + +.. rst-class:: classref-method + +:ref:`Vector3` **scale_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| + +Returns the interpolated scale value at the given time (in seconds). The ``track_idx`` must be the index of a 3D scale track. + +.. rst-class:: classref-item-separator + +---- + .. _class_Animation_method_track_find_key: .. rst-class:: classref-method diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index 223eab5fb41..f69b2bfa214 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -52,49 +52,49 @@ Methods .. table:: :widths: auto - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_caption` **(** **)** |virtual| |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationNode` | :ref:`_get_child_by_name` **(** :ref:`StringName` name **)** |virtual| |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_child_nodes` **(** **)** |virtual| |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_parameter_default_value` **(** :ref:`StringName` parameter **)** |virtual| |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`_get_parameter_list` **(** **)** |virtual| |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_filter` **(** **)** |virtual| |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_parameter_read_only` **(** :ref:`StringName` parameter **)** |virtual| |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_process` **(** :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking **)** |virtual| |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_input` **(** :ref:`String` name **)** | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`blend_animation` **(** :ref:`StringName` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`bool` is_external_seeking, :ref:`float` blend, :ref:`LoopedFlag` looped_flag=0 **)** | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`blend_input` **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` sync=true **)** | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`blend_node` **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` sync=true **)** | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find_input` **(** :ref:`String` name **)** |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_input_count` **(** **)** |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_input_name` **(** :ref:`int` input **)** |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_parameter` **(** :ref:`StringName` name **)** |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_input` **(** :ref:`int` index **)** | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_filter_path` **(** :ref:`NodePath` path, :ref:`bool` enable **)** | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`set_input_name` **(** :ref:`int` input, :ref:`String` name **)** | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_parameter` **(** :ref:`StringName` name, :ref:`Variant` value **)** | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_caption` **(** **)** |virtual| |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationNode` | :ref:`_get_child_by_name` **(** :ref:`StringName` name **)** |virtual| |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_child_nodes` **(** **)** |virtual| |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_parameter_default_value` **(** :ref:`StringName` parameter **)** |virtual| |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`_get_parameter_list` **(** **)** |virtual| |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_filter` **(** **)** |virtual| |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_parameter_read_only` **(** :ref:`StringName` parameter **)** |virtual| |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_process` **(** :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking, :ref:`bool` test_only **)** |virtual| |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_input` **(** :ref:`String` name **)** | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`blend_animation` **(** :ref:`StringName` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`bool` is_external_seeking, :ref:`float` blend, :ref:`LoopedFlag` looped_flag=0 **)** | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`blend_input` **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` sync=true, :ref:`bool` test_only=false **)** | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`blend_node` **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` sync=true, :ref:`bool` test_only=false **)** | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find_input` **(** :ref:`String` name **)** |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_input_count` **(** **)** |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_input_name` **(** :ref:`int` input **)** |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_parameter` **(** :ref:`StringName` name **)** |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`remove_input` **(** :ref:`int` index **)** | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_filter_path` **(** :ref:`NodePath` path, :ref:`bool` enable **)** | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`set_input_name` **(** :ref:`int` input, :ref:`String` name **)** | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_parameter` **(** :ref:`StringName` name, :ref:`Variant` value **)** | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -303,7 +303,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`float` **_process** **(** :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking **)** |virtual| |const| +:ref:`float` **_process** **(** :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking, :ref:`bool` test_only **)** |virtual| |const| When inheriting from :ref:`AnimationRootNode`, implement this virtual method to run some code when this node is processed. The ``time`` parameter is a relative delta, unless ``seek`` is ``true``, in which case it is absolute. @@ -345,7 +345,7 @@ A ``looped_flag`` is used by internal processing immediately after the loop. See .. rst-class:: classref-method -:ref:`float` **blend_input** **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` sync=true **)** +:ref:`float` **blend_input** **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` sync=true, :ref:`bool` test_only=false **)** Blend an input. This is only useful for nodes created for an :ref:`AnimationNodeBlendTree`. The ``time`` parameter is a relative delta, unless ``seek`` is ``true``, in which case it is absolute. A filter mode may be optionally passed (see :ref:`FilterAction` for options). @@ -357,7 +357,7 @@ Blend an input. This is only useful for nodes created for an :ref:`AnimationNode .. rst-class:: classref-method -:ref:`float` **blend_node** **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` sync=true **)** +:ref:`float` **blend_node** **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` sync=true, :ref:`bool` test_only=false **)** Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode` instead, else editors will not display your node for addition. diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index b9af0a4ea99..85f22a751f4 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -53,9 +53,13 @@ Properties .. table:: :widths: auto - +-------------------------+----------------------------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`allow_transition_to_self` | ``false`` | - +-------------------------+----------------------------------------------------------------------------------------------------+-----------+ + +--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`allow_transition_to_self` | ``false`` | + +--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`reset_ends` | ``false`` | + +--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ + | :ref:`StateMachineType` | :ref:`state_machine_type` | ``0`` | + +--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group @@ -111,6 +115,45 @@ Methods .. rst-class:: classref-descriptions-group +Enumerations +------------ + +.. _enum_AnimationNodeStateMachine_StateMachineType: + +.. rst-class:: classref-enumeration + +enum **StateMachineType**: + +.. _class_AnimationNodeStateMachine_constant_STATE_MACHINE_TYPE_ROOT: + +.. rst-class:: classref-enumeration-constant + +:ref:`StateMachineType` **STATE_MACHINE_TYPE_ROOT** = ``0`` + +Seeking to the beginning is treated as playing from the start state. Transition to the end state is treated as exiting the state machine. + +.. _class_AnimationNodeStateMachine_constant_STATE_MACHINE_TYPE_NESTED: + +.. rst-class:: classref-enumeration-constant + +:ref:`StateMachineType` **STATE_MACHINE_TYPE_NESTED** = ``1`` + +Seeking to the beginning is treated as seeking to the beginning of the animation in the current state. Transition to the end state, or the absence of transitions in each state, is treated as exiting the state machine. + +.. _class_AnimationNodeStateMachine_constant_STATE_MACHINE_TYPE_GROUPED: + +.. rst-class:: classref-enumeration-constant + +:ref:`StateMachineType` **STATE_MACHINE_TYPE_GROUPED** = ``2`` + +This is a grouped state machine that can be controlled from a parent state machine. It does not work on standalone. There must be a state machine with :ref:`state_machine_type` of :ref:`STATE_MACHINE_TYPE_ROOT` or :ref:`STATE_MACHINE_TYPE_NESTED` in the parent or ancestor. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Property Descriptions --------------------- @@ -127,6 +170,42 @@ Property Descriptions If ``true``, allows teleport to the self state with :ref:`AnimationNodeStateMachinePlayback.travel`. When the reset option is enabled in :ref:`AnimationNodeStateMachinePlayback.travel`, the animation is restarted. If ``false``, nothing happens on the teleportation to the self state. +.. rst-class:: classref-item-separator + +---- + +.. _class_AnimationNodeStateMachine_property_reset_ends: + +.. rst-class:: classref-property + +:ref:`bool` **reset_ends** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_reset_ends** **(** :ref:`bool` value **)** +- :ref:`bool` **are_ends_reset** **(** **)** + +If ``true``, treat the cross-fade to the start and end nodes as a blend with the RESET animation. + +In most cases, when additional cross-fades are performed in the parent :ref:`AnimationNode` of the state machine, setting this property to ``false`` and matching the cross-fade time of the parent :ref:`AnimationNode` and the state machine's start node and end node gives good results. + +.. rst-class:: classref-item-separator + +---- + +.. _class_AnimationNodeStateMachine_property_state_machine_type: + +.. rst-class:: classref-property + +:ref:`StateMachineType` **state_machine_type** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_state_machine_type** **(** :ref:`StateMachineType` value **)** +- :ref:`StateMachineType` **get_state_machine_type** **(** **)** + +This property can define the process of transitions for different use cases. See also :ref:`StateMachineType`. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 4631df46fef..fc30973a5c6 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -308,7 +308,7 @@ Property Descriptions - void **set_assigned_animation** **(** :ref:`String` value **)** - :ref:`String` **get_assigned_animation** **(** **)** -If playing, the the current animation's key, otherwise, the animation last played. When set, this changes the animation, but will not play it unless already playing. See also :ref:`current_animation`. +If playing, the current animation's key, otherwise, the animation last played. When set, this changes the animation, but will not play it unless already playing. See also :ref:`current_animation`. .. rst-class:: classref-item-separator diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index c5408cd6e13..81fd8f82f58 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -75,7 +75,7 @@ Properties +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`bool` | :ref:`monitoring` | ``true`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ - | :ref:`float` | :ref:`priority` | ``0.0`` | + | :ref:`int` | :ref:`priority` | ``0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ .. rst-class:: classref-reftable-group @@ -551,14 +551,14 @@ If ``true``, the area detects bodies or areas entering and exiting it. .. rst-class:: classref-property -:ref:`float` **priority** = ``0.0`` +:ref:`int` **priority** = ``0`` .. rst-class:: classref-property-setget -- void **set_priority** **(** :ref:`float` value **)** -- :ref:`float` **get_priority** **(** **)** +- void **set_priority** **(** :ref:`int` value **)** +- :ref:`int` **get_priority** **(** **)** -The area's priority. Higher priority areas are processed first. +The area's priority. Higher priority areas are processed first. The :ref:`World2D`'s physics is always processed last, after all areas. .. rst-class:: classref-section-separator diff --git a/classes/class_area3d.rst b/classes/class_area3d.rst index 346dba0d953..01b702fe1f1 100644 --- a/classes/class_area3d.rst +++ b/classes/class_area3d.rst @@ -73,7 +73,7 @@ Properties +-------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`monitoring` | ``true`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`priority` | ``0.0`` | + | :ref:`int` | :ref:`priority` | ``0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`reverb_bus_amount` | ``0.0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-----------------------+ @@ -563,14 +563,14 @@ If ``true``, the area detects bodies or areas entering and exiting it. .. rst-class:: classref-property -:ref:`float` **priority** = ``0.0`` +:ref:`int` **priority** = ``0`` .. rst-class:: classref-property-setget -- void **set_priority** **(** :ref:`float` value **)** -- :ref:`float` **get_priority** **(** **)** +- void **set_priority** **(** :ref:`int` value **)** +- :ref:`int` **get_priority** **(** **)** -The area's priority. Higher priority areas are processed first. +The area's priority. Higher priority areas are processed first. The :ref:`World3D`'s physics is always processed last, after all areas. .. rst-class:: classref-item-separator @@ -689,7 +689,7 @@ The magnitude of area-specific wind force. - void **set_wind_source_path** **(** :ref:`NodePath` value **)** - :ref:`NodePath` **get_wind_source_path** **(** **)** -The :ref:`Node3D` which is used to specify the the direction and origin of an area-specific wind force. The direction is opposite to the z-axis of the :ref:`Node3D`'s local transform, and its origin is the origin of the :ref:`Node3D`'s local transform. +The :ref:`Node3D` which is used to specify the direction and origin of an area-specific wind force. The direction is opposite to the z-axis of the :ref:`Node3D`'s local transform, and its origin is the origin of the :ref:`Node3D`'s local transform. .. rst-class:: classref-section-separator diff --git a/classes/class_array.rst b/classes/class_array.rst index 101ddf12895..0d33e1730c1 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -70,8 +70,6 @@ Arrays can be concatenated using the ``+`` operator: \ **Note:** Erasing elements while iterating over arrays is **not** supported and will result in unpredictable behavior. -\ **Note:** When declaring an array with ``const``, the array itself can still be mutated by defining the values at individual indices or pushing/removing elements. Using ``const`` will only prevent assigning the constant with another value after it was initialized. - .. rst-class:: classref-reftable-group Constructors @@ -873,6 +871,18 @@ See also :ref:`filter`, :ref:`reduce`. In this example every array element is checked and the first maximum value is returned: + +:: + + func _ready(): + var arr = [Vector2(0, 1), Vector2(2, 0), Vector2(1, 1), Vector2(1, 0), Vector2(0, 2)] + # In this example we compare the lengths. + print(arr.reduce(func(max, val): return val if is_length_greater(val, max) else max)) + + func is_length_greater(a, b): + return a.length() > b.length() + .. rst-class:: classref-item-separator ---- @@ -885,6 +895,8 @@ Returns the maximum value contained in the array if all elements are of comparab Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. +See also :ref:`max` for an example of using a custom comparator. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_astargrid2d.rst b/classes/class_astargrid2d.rst index 59ae9183a9b..5315e3c38ba 100644 --- a/classes/class_astargrid2d.rst +++ b/classes/class_astargrid2d.rst @@ -21,7 +21,7 @@ Description Compared to :ref:`AStar2D` you don't need to manually create points or connect them together. It also supports multiple type of heuristics and modes for diagonal movement. This class also provides a jumping mode which is faster to calculate than without it in the :ref:`AStar2D` class. -In contrast to :ref:`AStar2D`, you only need set the :ref:`size` of the grid, optionally set the :ref:`cell_size` and then call the :ref:`update` method: +In contrast to :ref:`AStar2D`, you only need set the :ref:`region` of the grid, optionally set the :ref:`cell_size` and then call the :ref:`update` method: .. tabs:: @@ -29,7 +29,7 @@ In contrast to :ref:`AStar2D`, you only need set the :ref:`size` | :ref:`cell_size` | ``Vector2(1, 1)`` | - +----------------------------------------------------+------------------------------------------------------------------------------------------+--------------------+ - | :ref:`Heuristic` | :ref:`default_compute_heuristic` | ``0`` | - +----------------------------------------------------+------------------------------------------------------------------------------------------+--------------------+ - | :ref:`Heuristic` | :ref:`default_estimate_heuristic` | ``0`` | - +----------------------------------------------------+------------------------------------------------------------------------------------------+--------------------+ - | :ref:`DiagonalMode` | :ref:`diagonal_mode` | ``0`` | - +----------------------------------------------------+------------------------------------------------------------------------------------------+--------------------+ - | :ref:`bool` | :ref:`jumping_enabled` | ``false`` | - +----------------------------------------------------+------------------------------------------------------------------------------------------+--------------------+ - | :ref:`Vector2` | :ref:`offset` | ``Vector2(0, 0)`` | - +----------------------------------------------------+------------------------------------------------------------------------------------------+--------------------+ - | :ref:`Vector2i` | :ref:`size` | ``Vector2i(0, 0)`` | - +----------------------------------------------------+------------------------------------------------------------------------------------------+--------------------+ + +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ + | :ref:`Vector2` | :ref:`cell_size` | ``Vector2(1, 1)`` | + +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ + | :ref:`Heuristic` | :ref:`default_compute_heuristic` | ``0`` | + +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ + | :ref:`Heuristic` | :ref:`default_estimate_heuristic` | ``0`` | + +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ + | :ref:`DiagonalMode` | :ref:`diagonal_mode` | ``0`` | + +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ + | :ref:`bool` | :ref:`jumping_enabled` | ``false`` | + +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ + | :ref:`Vector2` | :ref:`offset` | ``Vector2(0, 0)`` | + +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ + | :ref:`Rect2i` | :ref:`region` | ``Rect2i(0, 0, 0, 0)`` | + +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ + | :ref:`Vector2i` | :ref:`size` | ``Vector2i(0, 0)`` | + +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ .. rst-class:: classref-reftable-group @@ -355,6 +357,23 @@ The offset of the grid which will be applied to calculate the resulting point po ---- +.. _class_AStarGrid2D_property_region: + +.. rst-class:: classref-property + +:ref:`Rect2i` **region** = ``Rect2i(0, 0, 0, 0)`` + +.. rst-class:: classref-property-setget + +- void **set_region** **(** :ref:`Rect2i` value **)** +- :ref:`Rect2i` **get_region** **(** **)** + +The region of grid cells available for pathfinding. If changed, :ref:`update` needs to be called before finding the next path. + +.. rst-class:: classref-item-separator + +---- + .. _class_AStarGrid2D_property_size: .. rst-class:: classref-property @@ -368,6 +387,8 @@ The offset of the grid which will be applied to calculate the resulting point po The size of the grid (number of cells of size :ref:`cell_size` on each axis). If changed, :ref:`update` needs to be called before finding the next path. +\ **Note:** This property is deprecated, use :ref:`region` instead. + .. rst-class:: classref-section-separator ---- @@ -411,7 +432,7 @@ Note that this function is hidden in the default ``AStarGrid2D`` class. void **clear** **(** **)** -Clears the grid and sets the :ref:`size` to :ref:`Vector2i.ZERO`. +Clears the grid and sets the :ref:`region` to ``Rect2i(0, 0, 0, 0)``. .. rst-class:: classref-item-separator @@ -549,7 +570,9 @@ Sets the ``weight_scale`` for the point with the given ``id``. The ``weight_scal void **update** **(** **)** -Updates the internal state of the grid according to the parameters to prepare it to search the path. Needs to be called if parameters like :ref:`size`, :ref:`cell_size` or :ref:`offset` are changed. :ref:`is_dirty` will return ``true`` if this is the case and this needs to be called. +Updates the internal state of the grid according to the parameters to prepare it to search the path. Needs to be called if parameters like :ref:`region`, :ref:`cell_size` or :ref:`offset` are changed. :ref:`is_dirty` will return ``true`` if this is the case and this needs to be called. + +\ **Note:** All point data (solidity and weight scale) will be cleared. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index d08c024d86d..f88a660008a 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -250,6 +250,8 @@ Determines when the button is considered clicked, one of the :ref:`ActionMode` associated with the button. Not to be confused with node groups. +\ **Note:** The button will be configured as a radio button if a :ref:`ButtonGroup` is assigned to it. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst index 70f632b993c..e4582ecaa05 100644 --- a/classes/class_basematerial3d.rst +++ b/classes/class_basematerial3d.rst @@ -3134,7 +3134,7 @@ Repeat flags for the texture. See :ref:`TextureFilter` value **)** - :ref:`Transparency` **get_transparency** **(** **)** -If ``true``, transparency is enabled on the body. Some transparency modes will disable shadow casting. Any transparency mode other than Disabled has a greater performance impact compared to opaque rendering. See also :ref:`blend_mode`. +The material's transparency mode. Some transparency modes will disable shadow casting. Any transparency mode other than :ref:`TRANSPARENCY_DISABLED` has a greater performance impact compared to opaque rendering. See also :ref:`blend_mode`. .. rst-class:: classref-item-separator diff --git a/classes/class_button.rst b/classes/class_button.rst index 85f3a0b85fe..945e39df267 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -138,6 +138,8 @@ Theme Properties +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`h_separation` | ``2`` | +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`int` | :ref:`icon_max_width` | ``0`` | + +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`outline_size` | ``0`` | +---------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Font` | :ref:`font` | | @@ -209,7 +211,7 @@ When this property is enabled, text that is too large to fit the button is clipp - void **set_expand_icon** **(** :ref:`bool` value **)** - :ref:`bool` **is_expand_icon** **(** **)** -When enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect. +When enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect. See also :ref:`icon_max_width`. .. rst-class:: classref-item-separator @@ -509,6 +511,18 @@ The horizontal space between **Button**'s icon and text. Negative values will be ---- +.. _class_Button_theme_constant_icon_max_width: + +.. rst-class:: classref-themeproperty + +:ref:`int` **icon_max_width** = ``0`` + +The maximum allowed width of the **Button**'s icon. This limit is applied on top of the default size of the icon, or its expanded size if :ref:`expand_icon` is ``true``. The height is adjusted according to the icon's ratio. + +.. rst-class:: classref-item-separator + +---- + .. _class_Button_theme_constant_outline_size: .. rst-class:: classref-themeproperty diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index b0f2a550171..ca28dce45d1 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -19,7 +19,7 @@ Group of Buttons. Description ----------- -Group of :ref:`BaseButton`. The members of this group are treated like radio buttons in the sense that only one button can be pressed at the same time. +Group of :ref:`BaseButton`. The members of this group are treated like radio buttons in the sense that only one button can be pressed at the same time. Some types of buttons (such as :ref:`CheckBox`) may have a special appearance for this state. Every member of the ButtonGroup should have :ref:`BaseButton.toggle_mode` set to ``true``. @@ -31,9 +31,11 @@ Properties .. table:: :widths: auto - +-------------------------+-------------------------+---------------------------------------------------------------------------------------+ - | :ref:`bool` | resource_local_to_scene | ``true`` (overrides :ref:`Resource`) | - +-------------------------+-------------------------+---------------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`allow_unpress` | ``false`` | + +-------------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------+ + | :ref:`bool` | resource_local_to_scene | ``true`` (overrides :ref:`Resource`) | + +-------------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -72,6 +74,28 @@ Emitted when one of the buttons of the group is pressed. .. rst-class:: classref-descriptions-group +Property Descriptions +--------------------- + +.. _class_ButtonGroup_property_allow_unpress: + +.. rst-class:: classref-property + +:ref:`bool` **allow_unpress** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_allow_unpress** **(** :ref:`bool` value **)** +- :ref:`bool` **is_allow_unpress** **(** **)** + +If ``true``, it is possible to unpress all buttons in this **ButtonGroup**. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Method Descriptions ------------------- diff --git a/classes/class_callable.rst b/classes/class_callable.rst index 3465cdce834..90a9ace5560 100644 --- a/classes/class_callable.rst +++ b/classes/class_callable.rst @@ -196,7 +196,9 @@ Method Descriptions :ref:`Callable` **bind** **(** ... **)** |vararg| |const| -Returns a copy of this **Callable** with one or more arguments bound. When called, the bound arguments are passed *after* the arguments supplied by :ref:`call`. +Returns a copy of this **Callable** with one or more arguments bound. When called, the bound arguments are passed *after* the arguments supplied by :ref:`call`. See also :ref:`unbind`. + +\ **Note:** When this method is chained with other similar methods, the order in which the argument list is modified is read from right to left. .. rst-class:: classref-item-separator @@ -208,7 +210,9 @@ Returns a copy of this **Callable** with one or more arguments bound. When calle :ref:`Callable` **bindv** **(** :ref:`Array` arguments **)** -Returns a copy of this **Callable** with one or more arguments bound, reading them from an array. When called, the bound arguments are passed *after* the arguments supplied by :ref:`call`. +Returns a copy of this **Callable** with one or more arguments bound, reading them from an array. When called, the bound arguments are passed *after* the arguments supplied by :ref:`call`. See also :ref:`unbind`. + +\ **Note:** When this method is chained with other similar methods, the order in which the argument list is modified is read from right to left. .. rst-class:: classref-item-separator @@ -407,7 +411,15 @@ Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer do :ref:`Callable` **unbind** **(** :ref:`int` argcount **)** |const| -Returns a copy of this **Callable** with the arguments unbound, as defined by ``argcount``. 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. +Returns a copy of this **Callable** with a number of arguments unbound. In other words, when the new callable is called the last few arguments supplied by the user are ignored, according to ``argcount``. The remaining arguments are passed to the callable. This allows to use the original callable in a context that attempts to pass more arguments than this callable can handle, e.g. a signal with a fixed number of arguments. See also :ref:`bind`. + +\ **Note:** When this method is chained with other similar methods, the order in which the argument list is modified is read from right to left. + +:: + + func _ready(): + foo.unbind(1).call(1, 2) # Calls foo(1). + foo.bind(3, 4).unbind(1).call(1, 2) # Calls foo(1, 3, 4), note that it does not change the arguments from bind. .. rst-class:: classref-section-separator diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 1b1e75c68d0..fab5cae7307 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -549,7 +549,7 @@ The rendering layers in which this **CanvasItem** responds to :ref:`Light2D` value **)** - :ref:`Material` **get_material** **(** **)** -The material applied to textures on this **CanvasItem**. +The material applied to this **CanvasItem**. .. rst-class:: classref-item-separator @@ -566,7 +566,7 @@ The material applied to textures on this **CanvasItem**. - void **set_modulate** **(** :ref:`Color` value **)** - :ref:`Color` **get_modulate** **(** **)** -The color applied to textures on this **CanvasItem**. +The color applied to this **CanvasItem**. This property does affect child **CanvasItem**\ s, unlike :ref:`self_modulate` which only affects the node itself. .. rst-class:: classref-item-separator @@ -583,7 +583,9 @@ The color applied to textures on this **CanvasItem**. - void **set_self_modulate** **(** :ref:`Color` value **)** - :ref:`Color` **get_self_modulate** **(** **)** -The color applied to textures on this **CanvasItem**. This is not inherited by children **CanvasItem**\ s. +The color applied to this **CanvasItem**. This property does **not** affect child **CanvasItem**\ s, unlike :ref:`modulate` which affects both the node itself and its children. + +\ **Note:** Internal children (e.g. sliders in :ref:`ColorPicker` or tab bar in :ref:`TabContainer`) are also not affected by this property (see ``include_internal`` parameter of :ref:`Node.get_child` and other similar methods). .. rst-class:: classref-item-separator @@ -1264,6 +1266,8 @@ Returns the transform from the coordinate system of the canvas, this item is in, Returns the mouse's position in the :ref:`CanvasLayer` that this **CanvasItem** is in using the coordinate system of the :ref:`CanvasLayer`. +\ **Note:** For screen-space coordinates (e.g. when using a non-embedded :ref:`Popup`), you can use :ref:`DisplayServer.mouse_get_position`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_characterbody2d.rst b/classes/class_characterbody2d.rst index 95552413f60..69cfba3a510 100644 --- a/classes/class_characterbody2d.rst +++ b/classes/class_characterbody2d.rst @@ -86,6 +86,8 @@ Methods .. table:: :widths: auto + +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`apply_floor_snap` **(** **)** | +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_floor_angle` **(** :ref:`Vector2` up_direction=Vector2(0, -1) **)** |const| | +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -262,7 +264,7 @@ Maximum angle (in radians) where a slope is still considered a floor (or a ceili Sets a snapping distance. When set to a value different from ``0.0``, the body is kept attached to slopes when calling :ref:`move_and_slide`. The snapping vector is determined by the given distance along the opposite direction of the :ref:`up_direction`. -As long as the snapping vector is in contact with the ground and the body moves against :ref:`up_direction`, the body will remain attached to the surface. Snapping is not applied if the body moves along :ref:`up_direction`, so it will be able to detach from the ground when jumping. +As long as the snapping vector is in contact with the ground and the body moves against :ref:`up_direction`, the body will remain attached to the surface. Snapping is not applied if the body moves along :ref:`up_direction`, meaning it contains vertical rising velocity, so it will be able to detach from the ground when jumping or when the body is pushed up by something. If you want to apply a snap without taking into account the velocity, use :ref:`apply_floor_snap`. .. rst-class:: classref-item-separator @@ -468,6 +470,18 @@ Minimum angle (in radians) where the body is allowed to slide when it encounters Method Descriptions ------------------- +.. _class_CharacterBody2D_method_apply_floor_snap: + +.. rst-class:: classref-method + +void **apply_floor_snap** **(** **)** + +Allows to manually apply a snap to the floor regardless of the body's velocity. This function does nothing when :ref:`is_on_floor` returns ``true``. + +.. rst-class:: classref-item-separator + +---- + .. _class_CharacterBody2D_method_get_floor_angle: .. rst-class:: classref-method @@ -568,8 +582,8 @@ Returns a :ref:`KinematicCollision2D`, which contain .. code-tab:: gdscript for i in get_slide_collision_count(): - var collision = get_slide_collision(i) - print("Collided with: ", collision.collider.name) + var collision = get_slide_collision(i) + print("Collided with: ", collision.get_collider().name) .. code-tab:: csharp diff --git a/classes/class_characterbody3d.rst b/classes/class_characterbody3d.rst index 3407fa3d76a..d1104863695 100644 --- a/classes/class_characterbody3d.rst +++ b/classes/class_characterbody3d.rst @@ -90,6 +90,8 @@ Methods .. table:: :widths: auto + +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`apply_floor_snap` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_floor_angle` **(** :ref:`Vector3` up_direction=Vector3(0, 1, 0) **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -268,7 +270,7 @@ Maximum angle (in radians) where a slope is still considered a floor (or a ceili Sets a snapping distance. When set to a value different from ``0.0``, the body is kept attached to slopes when calling :ref:`move_and_slide`. The snapping vector is determined by the given distance along the opposite direction of the :ref:`up_direction`. -As long as the snapping vector is in contact with the ground and the body moves against :ref:`up_direction`, the body will remain attached to the surface. Snapping is not applied if the body moves along :ref:`up_direction`, so it will be able to detach from the ground when jumping. +As long as the snapping vector is in contact with the ground and the body moves against :ref:`up_direction`, the body will remain attached to the surface. Snapping is not applied if the body moves along :ref:`up_direction`, meaning it contains vertical rising velocity, so it will be able to detach from the ground when jumping or when the body is pushed up by something. If you want to apply a snap without taking into account the velocity, use :ref:`apply_floor_snap`. .. rst-class:: classref-item-separator @@ -474,6 +476,18 @@ Minimum angle (in radians) where the body is allowed to slide when it encounters Method Descriptions ------------------- +.. _class_CharacterBody3D_method_apply_floor_snap: + +.. rst-class:: classref-method + +void **apply_floor_snap** **(** **)** + +Allows to manually apply a snap to the floor regardless of the body's velocity. This function does nothing when :ref:`is_on_floor` returns ``true``. + +.. rst-class:: classref-item-separator + +---- + .. _class_CharacterBody3D_method_get_floor_angle: .. rst-class:: classref-method diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index 684800b32bc..f37d92cdd39 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -23,6 +23,8 @@ A checkbox allows the user to make a binary choice (choosing only one of two pos See also :ref:`BaseButton` which contains common properties and methods associated with this node. +\ **Note:** CheckBox changes its appearance when it's configured as a radio button. See various ``radio_*`` theme properties. To configure CheckBox to act as a radio button, use :ref:`BaseButton.button_group` and :ref:`ButtonGroup`. + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 7372223461c..f066c8cf48a 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -12,14 +12,16 @@ CollisionPolygon2D **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -Defines a 2D collision polygon. +Node that represents a 2D collision polygon. .. rst-class:: classref-introduction-group Description ----------- -Provides a concave or convex 2D collision polygon to a :ref:`CollisionObject2D` parent. Polygons can be drawn in the editor or specified by a list of vertices. See also :ref:`ConvexPolygonShape2D`. +Provides a 2D collision polygon to a :ref:`CollisionObject2D` parent. Polygons can be drawn in the editor or specified by a list of vertices. + +Depending on the build mode, this node effectively provides several convex shapes (by convex decomposition of the polygon) or a single concave shape made of the polygon's segments. In the editor, a **CollisionPolygon2D** can be generated from a :ref:`Sprite2D`'s outline by selecting a :ref:`Sprite2D` node, going to the **Sprite2D** menu at the top of the 2D editor viewport then choosing **Create CollisionPolygon2D Sibling**. @@ -64,7 +66,7 @@ enum **BuildMode**: :ref:`BuildMode` **BUILD_SOLIDS** = ``0`` -Collisions will include the polygon and its contained area. +Collisions will include the polygon and its contained area. In this mode the node has the same effect as several :ref:`ConvexPolygonShape2D` nodes, one for each convex shape in the convex decomposition of the polygon (but without the overhead of multiple nodes). .. _class_CollisionPolygon2D_constant_BUILD_SEGMENTS: @@ -72,7 +74,7 @@ Collisions will include the polygon and its contained area. :ref:`BuildMode` **BUILD_SEGMENTS** = ``1`` -Collisions will only include the polygon edges. +Collisions will only include the polygon edges. In this mode the node has the same effect as a single :ref:`ConcavePolygonShape2D` made of segments, with the restriction that each segment (after the first one) starts where the previous one ends, and the last one ends where the first one starts (forming a closed but hollow polygon). .. rst-class:: classref-section-separator @@ -164,7 +166,9 @@ The margin used for one-way collision (in pixels). Higher values will make the s - void **set_polygon** **(** :ref:`PackedVector2Array` value **)** - :ref:`PackedVector2Array` **get_polygon** **(** **)** -The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the :ref:`PackedVector2Array`, not a reference. +The polygon's list of vertices. Each point will be connected to the next, and the final point will be connected to the first. + +\ **Warning:** The returned value is a clone of the :ref:`PackedVector2Array`, not a reference. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_collisionpolygon3d.rst b/classes/class_collisionpolygon3d.rst index 80afbc92c5d..e811559a9c0 100644 --- a/classes/class_collisionpolygon3d.rst +++ b/classes/class_collisionpolygon3d.rst @@ -12,16 +12,16 @@ CollisionPolygon3D **Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -Editor-only node for defining a collision polygon in 3D space. +Node that represents a 3D collision polygon, given by the thickening of a 2D polygon in the local XY plane along the local Z axis. .. rst-class:: classref-introduction-group Description ----------- -Allows editing a concave or convex collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at run-time. Creates several :ref:`ConvexPolygonShape3D`\ s at run-time to represent the original polygon using convex decomposition. +Provides a 3D collision polygon to a :ref:`CollisionObject3D` parent, by thickening a 2D (convex or concave) polygon in the local XY plane along the local Z axis. The 2D polygon in the local XY plane can be drawn in the editor or specified by a list of vertices. That 2D polygon is thickened evenly in the local Z and -Z directions. -\ **Note:** Since this is an editor-only helper, properties modified during gameplay will have no effect. +This node has the same effect as several :ref:`ConvexPolygonShape3D` nodes, created by thickening the 2D convex polygons in the convex decomposition of the given 2D polygon (but without the overhead of multiple nodes). \ **Warning:** A non-uniformly scaled CollisionPolygon3D node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change its :ref:`polygon`'s vertices instead. @@ -63,7 +63,7 @@ Property Descriptions - void **set_depth** **(** :ref:`float` value **)** - :ref:`float` **get_depth** **(** **)** -Length that the resulting collision extends in either direction perpendicular to its polygon. +Length that the resulting collision extends in either direction perpendicular to its 2D polygon. .. rst-class:: classref-item-separator @@ -114,7 +114,7 @@ The collision margin for the generated :ref:`Shape3D`. See :ref:` - void **set_polygon** **(** :ref:`PackedVector2Array` value **)** - :ref:`PackedVector2Array` **get_polygon** **(** **)** -Array of vertices which define the polygon. +Array of vertices which define the 2D polygon in the local XY plane. \ **Note:** The returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the ``polygon`` member. diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 7a3edb78070..07579d5cfd4 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -19,7 +19,7 @@ Node that represents collision shape data in 2D space. Description ----------- -Editor facility for creating and editing collision shapes in 2D space. Set the :ref:`shape` property to configure the shape. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`CollisionObject2D.shape_owner_get_shape` to get the actual shape. +Editor facility for creating and editing collision shapes in 2D space. Set the :ref:`shape` property to configure the shape. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D` to give it a detection shape, or add it to a :ref:`PhysicsBody2D` to create a solid object. diff --git a/classes/class_collisionshape3d.rst b/classes/class_collisionshape3d.rst index 19398fcaaba..0802b638da7 100644 --- a/classes/class_collisionshape3d.rst +++ b/classes/class_collisionshape3d.rst @@ -19,7 +19,7 @@ Node that represents collision shape data in 3D space. Description ----------- -Editor facility for creating and editing collision shapes in 3D space. Set the :ref:`shape` property to configure the shape. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`CollisionObject3D.shape_owner_get_shape` to get the actual shape. +Editor facility for creating and editing collision shapes in 3D space. Set the :ref:`shape` property to configure the shape. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area3D` to give it a detection shape, or add it to a :ref:`PhysicsBody3D` to create a solid object. diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index be5dd4fd07e..228db859c99 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -92,43 +92,45 @@ Theme Properties .. table:: :widths: auto - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`h_width` | ``30`` | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`label_width` | ``10`` | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`margin` | ``4`` | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`sv_height` | ``256`` | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`sv_width` | ``256`` | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`add_preset` | | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`bar_arrow` | | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`color_hue` | | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`color_okhsl_hue` | | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`expanded_arrow` | | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`folded_arrow` | | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`overbright_indicator` | | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`picker_cursor` | | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`sample_bg` | | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`screen_picker` | | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`shape_circle` | | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`shape_rect` | | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`shape_rect_wheel` | | - +-----------------------------------+--------------------------------------------------------------------------------+---------+ + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`int` | :ref:`center_slider_grabbers` | ``1`` | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`int` | :ref:`h_width` | ``30`` | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`int` | :ref:`label_width` | ``10`` | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`int` | :ref:`margin` | ``4`` | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`int` | :ref:`sv_height` | ``256`` | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`int` | :ref:`sv_width` | ``256`` | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`Texture2D` | :ref:`add_preset` | | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`Texture2D` | :ref:`bar_arrow` | | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`Texture2D` | :ref:`color_hue` | | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`Texture2D` | :ref:`color_okhsl_hue` | | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`Texture2D` | :ref:`expanded_arrow` | | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`Texture2D` | :ref:`folded_arrow` | | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`Texture2D` | :ref:`overbright_indicator` | | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`Texture2D` | :ref:`picker_cursor` | | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`Texture2D` | :ref:`sample_bg` | | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`Texture2D` | :ref:`screen_picker` | | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`Texture2D` | :ref:`shape_circle` | | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`Texture2D` | :ref:`shape_rect` | | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + | :ref:`Texture2D` | :ref:`shape_rect_wheel` | | + +-----------------------------------+----------------------------------------------------------------------------------------+---------+ .. rst-class:: classref-section-separator @@ -554,6 +556,18 @@ Returns the list of colors in the recent presets of the color picker. Theme Property Descriptions --------------------------- +.. _class_ColorPicker_theme_constant_center_slider_grabbers: + +.. rst-class:: classref-themeproperty + +:ref:`int` **center_slider_grabbers** = ``1`` + +Overrides the :ref:`HSlider.center_grabber` theme property of the sliders. + +.. rst-class:: classref-item-separator + +---- + .. _class_ColorPicker_theme_constant_h_width: .. rst-class:: classref-themeproperty diff --git a/classes/class_compressedcubemap.rst b/classes/class_compressedcubemap.rst index e69c8af1bcb..a213b43b73a 100644 --- a/classes/class_compressedcubemap.rst +++ b/classes/class_compressedcubemap.rst @@ -21,14 +21,16 @@ Description A cubemap that is loaded from a ``.ccube`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. **CompressedCubemap** can use one of 4 compresson methods: -- Uncompressed (uncompressed on the GPU) - - Lossless (WebP or PNG, uncompressed on the GPU) - Lossy (WebP, uncompressed on the GPU) - VRAM Compressed (compressed on the GPU) +- VRAM Uncompressed (uncompressed on the GPU) + +- Basis Universal (compressed on the GPU. Lower file sizes than VRAM Compressed, but slower to compress and lower quality than VRAM Compressed) + Only **VRAM Compressed** actually reduces the memory usage on the GPU. The **Lossless** and **Lossy** compression methods will reduce the required storage on disk, but they will not reduce memory usage on the GPU as the texture is sent to the GPU uncompressed. Using **VRAM Compressed** also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless or lossy compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D. diff --git a/classes/class_compressedcubemaparray.rst b/classes/class_compressedcubemaparray.rst index fa085b54f33..80a1c51ca7b 100644 --- a/classes/class_compressedcubemaparray.rst +++ b/classes/class_compressedcubemaparray.rst @@ -21,14 +21,16 @@ Description A cubemap array that is loaded from a ``.ccubearray`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. **CompressedCubemapArray** can use one of 4 compresson methods: -- Uncompressed (uncompressed on the GPU) - - Lossless (WebP or PNG, uncompressed on the GPU) - Lossy (WebP, uncompressed on the GPU) - VRAM Compressed (compressed on the GPU) +- VRAM Uncompressed (uncompressed on the GPU) + +- Basis Universal (compressed on the GPU. Lower file sizes than VRAM Compressed, but slower to compress and lower quality than VRAM Compressed) + Only **VRAM Compressed** actually reduces the memory usage on the GPU. The **Lossless** and **Lossy** compression methods will reduce the required storage on disk, but they will not reduce memory usage on the GPU as the texture is sent to the GPU uncompressed. Using **VRAM Compressed** also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless or lossy compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D. diff --git a/classes/class_compressedtexture2d.rst b/classes/class_compressedtexture2d.rst index dbbe5e594b0..9ef346709e1 100644 --- a/classes/class_compressedtexture2d.rst +++ b/classes/class_compressedtexture2d.rst @@ -21,14 +21,16 @@ Description A texture that is loaded from a ``.ctex`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. **CompressedTexture2D** can use one of 4 compression methods (including a lack of any compression): -- Uncompressed (uncompressed on the GPU) - - Lossless (WebP or PNG, uncompressed on the GPU) - Lossy (WebP, uncompressed on the GPU) - VRAM Compressed (compressed on the GPU) +- VRAM Uncompressed (uncompressed on the GPU) + +- Basis Universal (compressed on the GPU. Lower file sizes than VRAM Compressed, but slower to compress and lower quality than VRAM Compressed) + Only **VRAM Compressed** actually reduces the memory usage on the GPU. The **Lossless** and **Lossy** compression methods will reduce the required storage on disk, but they will not reduce memory usage on the GPU as the texture is sent to the GPU uncompressed. Using **VRAM Compressed** also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless or lossy compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D. diff --git a/classes/class_compressedtexture2darray.rst b/classes/class_compressedtexture2darray.rst index d70e4e6b441..e4c372a3779 100644 --- a/classes/class_compressedtexture2darray.rst +++ b/classes/class_compressedtexture2darray.rst @@ -21,14 +21,16 @@ Description A texture array that is loaded from a ``.ctexarray`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. **CompressedTexture2DArray** can use one of 4 compresson methods: -- Uncompressed (uncompressed on the GPU) - - Lossless (WebP or PNG, uncompressed on the GPU) - Lossy (WebP, uncompressed on the GPU) - VRAM Compressed (compressed on the GPU) +- VRAM Uncompressed (uncompressed on the GPU) + +- Basis Universal (compressed on the GPU. Lower file sizes than VRAM Compressed, but slower to compress and lower quality than VRAM Compressed) + Only **VRAM Compressed** actually reduces the memory usage on the GPU. The **Lossless** and **Lossy** compression methods will reduce the required storage on disk, but they will not reduce memory usage on the GPU as the texture is sent to the GPU uncompressed. Using **VRAM Compressed** also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless or lossy compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D. diff --git a/classes/class_compressedtexturelayered.rst b/classes/class_compressedtexturelayered.rst index f95e69fce74..8e4f4244583 100644 --- a/classes/class_compressedtexturelayered.rst +++ b/classes/class_compressedtexturelayered.rst @@ -21,19 +21,7 @@ Base class for texture arrays that can optionally be compressed. Description ----------- -A texture array that is loaded from a ``.ctexarray`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. :ref:`CompressedTexture2D` can use one of 4 compresson methods: - -- Uncompressed (uncompressed on the GPU) - -- Lossless (WebP or PNG, uncompressed on the GPU) - -- Lossy (WebP, uncompressed on the GPU) - -- VRAM Compressed (compressed on the GPU) - -Only **VRAM Compressed** actually reduces the memory usage on the GPU. The **Lossless** and **Lossy** compression methods will reduce the required storage on disk, but they will not reduce memory usage on the GPU as the texture is sent to the GPU uncompressed. - -Using **VRAM Compressed** also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless or lossy compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D. +Base class for :ref:`CompressedTexture2DArray` and :ref:`CompressedTexture3D`. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. See also :ref:`TextureLayered`. .. rst-class:: classref-reftable-group diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 04c3232dd09..4661fe96d1c 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -19,14 +19,20 @@ Concave polygon shape resource for 2D physics. Description ----------- -2D concave polygon shape to be added as a *direct* child of a :ref:`PhysicsBody2D` or :ref:`Area2D` using a :ref:`CollisionShape2D` node. It is made out of segments and is optimal for complex polygonal concave collisions. However, it is not advised to use for :ref:`RigidBody2D` nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions. +2D concave polygon shape to be added as a *direct* child of a :ref:`PhysicsBody2D` or :ref:`Area2D` using a :ref:`CollisionShape2D` node. -The main difference between a :ref:`ConvexPolygonShape2D` and a **ConcavePolygonShape2D** is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex to speed up collision detection. +The shape consists of a collection of line segments, and as such it does not include any "inside" that the segments might be enclosing. If the segments do enclose anything, then the shape is *hollow*, as opposed to a :ref:`ConvexPolygonShape2D` which is solid. See also :ref:`CollisionPolygon2D`. -\ **Performance:** Due to its complexity, **ConcavePolygonShape2D** is the slowest collision shape to check collisions against. Its use should generally be limited to level geometry. For convex geometry, using :ref:`ConvexPolygonShape2D` will perform better. For dynamic physics bodies that need concave collision, several :ref:`ConvexPolygonShape2D`\ s can be used to represent its collision by using convex decomposition; see :ref:`ConvexPolygonShape2D`'s documentation for instructions. However, consider using primitive collision shapes such as :ref:`CircleShape2D` or :ref:`RectangleShape2D` first. +Being made out of line segments, this shape is the most freely configurable single 2D shape. It can be used to form (hollow) polygons of any nature, convex or concave. + +\ **Note:** When used for collision, **ConcavePolygonShape2D** is intended to work with static :ref:`PhysicsBody2D` nodes like :ref:`StaticBody2D` and is not recommended to use with :ref:`RigidBody2D` nodes in a mode other than Static. A :ref:`CollisionPolygon2D` in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better suited for static bodies. + +\ **Warning:** The nature of this shape makes it extra prone to being tunneled through by (small) fast physics bodies. For example, consider a (small) rigid body *Ball* traveling toward a static body *Box* at high speed. If the box uses a **ConcavePolygonShape2D** consisting of four segments, then the ball might end up inside the box or tunnel all the way through the box, if it goes fast enough. This is (partly) because the ball can only collide against the individual segments of the hollow box. In interactions with rigid bodies tunneling can be avoided by enabling continuous collision detection on the rigid body. \ **Warning:** Using this shape for an :ref:`Area2D` (via a :ref:`CollisionShape2D` node) may give unexpected results: the area will only detect collisions with the segments in the **ConcavePolygonShape2D** (and not with any "inside" of the shape, for example). +\ **Performance:** Due to its complexity, **ConcavePolygonShape2D** is the slowest collision shape to check collisions against. Its use should generally be limited to level geometry. For convex geometry, using :ref:`ConvexPolygonShape2D` will perform better. For dynamic physics bodies that need concave collision, several :ref:`ConvexPolygonShape2D`\ s can be used to represent its collision by using convex decomposition; see :ref:`ConvexPolygonShape2D`'s documentation for instructions. However, consider using primitive collision shapes such as :ref:`CircleShape2D` or :ref:`RectangleShape2D` first. + .. rst-class:: classref-reftable-group Properties @@ -59,7 +65,7 @@ Property Descriptions - void **set_segments** **(** :ref:`PackedVector2Array` value **)** - :ref:`PackedVector2Array` **get_segments** **(** **)** -The array of points that make up the **ConcavePolygonShape2D**'s line segments. +The array of points that make up the **ConcavePolygonShape2D**'s line segments. The array (of length divisible by two) is naturally divided into pairs (one pair for each segment); each pair consists of the starting point of a segment and the endpoint of a segment. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_concavepolygonshape3d.rst b/classes/class_concavepolygonshape3d.rst index 3c603a2e33d..39496bc2946 100644 --- a/classes/class_concavepolygonshape3d.rst +++ b/classes/class_concavepolygonshape3d.rst @@ -19,14 +19,20 @@ Concave polygon shape resource (also called "trimesh") for 3D physics. Description ----------- -3D concave polygon shape resource (also called "trimesh") to be added as a *direct* child of a :ref:`PhysicsBody3D` or :ref:`Area3D` using a :ref:`CollisionShape3D` node. This shape is created by feeding a list of triangles. Despite its name, **ConcavePolygonShape3D** can also store convex polygon shapes. However, unlike :ref:`ConvexPolygonShape3D`, **ConcavePolygonShape3D** is *not* limited to storing convex shapes exclusively. +3D concave polygon shape resource (also called "trimesh") to be added as a *direct* child of a :ref:`PhysicsBody3D` or :ref:`Area3D` using a :ref:`CollisionShape3D` node. -\ **Note:** When used for collision, **ConcavePolygonShape3D** is intended to work with static :ref:`PhysicsBody3D` nodes like :ref:`StaticBody3D` and will not work with :ref:`CharacterBody3D` or :ref:`RigidBody3D` with a mode other than Static. +The shape consists of a collection of triangle faces, and as such it does not include any "inside" that the faces might be enclosing. If the faces enclose anything, then the shape is *hollow*, as opposed to a :ref:`ConvexPolygonShape3D` which is solid. See also :ref:`CollisionPolygon3D`. -\ **Performance:** Due to its complexity, **ConcavePolygonShape3D** is the slowest collision shape to check collisions against. Its use should generally be limited to level geometry. For convex geometry, using :ref:`ConvexPolygonShape3D` will perform better. For dynamic physics bodies that need concave collision, several :ref:`ConvexPolygonShape3D`\ s can be used to represent its collision by using convex decomposition; see :ref:`ConvexPolygonShape3D`'s documentation for instructions. However, consider using primitive collision shapes such as :ref:`SphereShape3D` or :ref:`BoxShape3D` first. +Being made out of triangle faces, this shape is the most freely configurable single 3D shape. Despite its name, it can be used to form (hollow) polyhedra of any nature, convex or concave. + +\ **Note:** When used for collision, **ConcavePolygonShape3D** is intended to work with static :ref:`PhysicsBody3D` nodes like :ref:`StaticBody3D` and will not work with :ref:`CharacterBody3D` or :ref:`RigidBody3D` in a mode other than Static. + +\ **Warning:** The nature of this shape makes it extra prone to being tunneled through by (small) fast physics bodies. For example, consider a (small) rigid body *Ball* traveling toward a static body *Box* at high speed. If the box uses a **ConcavePolygonShape3D** consisting of twelve triangle faces (two triangle faces for each of the six sides of the box), then the ball might end up inside the box or tunnel all the way through the box, if it goes fast enough. This is (partly) because the ball can only collide against the individual faces of the hollow box. In interactions with rigid bodies tunneling can be avoided by enabling continuous collision detection on the rigid body. \ **Warning:** Using this shape for an :ref:`Area3D` (via a :ref:`CollisionShape3D` node, created e.g. by using the *Create Trimesh Collision Sibling* option in the *Mesh* menu that appears when selecting a :ref:`MeshInstance3D` node) may give unexpected results: the area will only detect collisions with the triangle faces in the **ConcavePolygonShape3D** (and not with any "inside" of the shape, for example); moreover it will only detect all such collisions if :ref:`backface_collision` is ``true``. +\ **Performance:** Due to its complexity, **ConcavePolygonShape3D** is the slowest collision shape to check collisions against. Its use should generally be limited to level geometry. For convex geometry, using :ref:`ConvexPolygonShape3D` will perform better. For dynamic physics bodies that need concave collision, several :ref:`ConvexPolygonShape3D`\ s can be used to represent its collision by using convex decomposition; see :ref:`ConvexPolygonShape3D`'s documentation for instructions. However, consider using primitive collision shapes such as :ref:`SphereShape3D` or :ref:`BoxShape3D` first. + .. rst-class:: classref-introduction-group Tutorials @@ -97,7 +103,7 @@ Method Descriptions :ref:`PackedVector3Array` **get_faces** **(** **)** |const| -Returns the faces (an array of triangles). +Returns the faces of the trimesh shape as an array of vertices. The array (of length divisible by three) is naturally divided into triples; each triple of vertices defines a triangle. .. rst-class:: classref-item-separator @@ -109,7 +115,7 @@ Returns the faces (an array of triangles). void **set_faces** **(** :ref:`PackedVector3Array` faces **)** -Sets the faces (an array of triangles). +Sets the faces of the trimesh shape from an array of vertices. The ``faces`` array should be composed of triples such that each triple of vertices defines a triangle. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_conetwistjoint3d.rst b/classes/class_conetwistjoint3d.rst index 1d9cf6cd140..4a06f9c14d2 100644 --- a/classes/class_conetwistjoint3d.rst +++ b/classes/class_conetwistjoint3d.rst @@ -247,9 +247,7 @@ Method Descriptions :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the value of the specified parameter. .. rst-class:: classref-item-separator @@ -261,9 +259,7 @@ Method Descriptions void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the value of the specified parameter. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_control.rst b/classes/class_control.rst index 3b193fe2854..5ca435281b1 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -159,6 +159,8 @@ Methods +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** |virtual| |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_tooltip` **(** :ref:`Vector2` at_position **)** |virtual| |const| | + +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** |virtual| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_has_point` **(** :ref:`Vector2` point **)** |virtual| |const| | @@ -1223,7 +1225,7 @@ Anchors the top edge of the node to the origin, the center or the end of its par - void **set_auto_translate** **(** :ref:`bool` value **)** - :ref:`bool` **is_auto_translating** **(** **)** -Toggles if any text should automatically change to its translated version depending on the current locale. Note that this will not affect any internal nodes (e.g. the popup of a :ref:`MenuButton`). +Toggles if any text should automatically change to its translated version depending on the current locale. Also decides if the node's strings should be parsed for POT generation. @@ -1327,7 +1329,7 @@ Tells Godot which node it should give focus to if the user presses the left arro - void **set_focus_neighbor** **(** :ref:`Side` side, :ref:`NodePath` neighbor **)** - :ref:`NodePath` **get_focus_neighbor** **(** :ref:`Side` side **)** |const| -Tells Godot which node it should give focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the :ref:`ProjectSettings.input/ui_right` input action. The node must be a **Control**. If this property is not set, Godot will give focus to the closest **Control** to the bottom of this one. +Tells Godot which node it should give focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the :ref:`ProjectSettings.input/ui_right` input action. The node must be a **Control**. If this property is not set, Godot will give focus to the closest **Control** to the right of this one. .. rst-class:: classref-item-separator @@ -1344,7 +1346,7 @@ Tells Godot which node it should give focus to if the user presses the right arr - void **set_focus_neighbor** **(** :ref:`Side` side, :ref:`NodePath` neighbor **)** - :ref:`NodePath` **get_focus_neighbor** **(** :ref:`Side` side **)** |const| -Tells Godot which node it should give focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the :ref:`ProjectSettings.input/ui_up` input action. The node must be a **Control**. If this property is not set, Godot will give focus to the closest **Control** to the bottom of this one. +Tells Godot which node it should give focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the :ref:`ProjectSettings.input/ui_up` input action. The node must be a **Control**. If this property is not set, Godot will give focus to the closest **Control** to the top of this one. .. rst-class:: classref-item-separator @@ -1993,6 +1995,20 @@ If not overridden, defaults to :ref:`Vector2.ZERO`. ---- +.. _class_Control_method__get_tooltip: + +.. rst-class:: classref-method + +:ref:`String` **_get_tooltip** **(** :ref:`Vector2` at_position **)** |virtual| |const| + +Virtual method to be implemented by the user. Returns the tooltip text for the position ``at_position`` in control's local coordinates, which will typically appear when the cursor is resting over this control. See :ref:`get_tooltip`. + +\ **Note:** If this method returns an empty :ref:`String`, no tooltip is displayed. + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_method__gui_input: .. rst-class:: classref-method @@ -2462,7 +2478,7 @@ Returns the minimum size for this control. See :ref:`custom_minimum_size` **get_offset** **(** :ref:`Side` offset **)** |const| -Returns the anchor for the specified :ref:`Side`. A getter method for :ref:`offset_bottom`, :ref:`offset_left`, :ref:`offset_right` and :ref:`offset_top`. +Returns the offset for the specified :ref:`Side`. A getter method for :ref:`offset_bottom`, :ref:`offset_left`, :ref:`offset_right` and :ref:`offset_top`. .. rst-class:: classref-item-separator @@ -2685,9 +2701,11 @@ See :ref:`get_theme_color` for details. :ref:`String` **get_tooltip** **(** :ref:`Vector2` at_position=Vector2(0, 0) **)** |const| -Returns the tooltip text ``at_position`` in local coordinates, which will typically appear when the cursor is resting over this control. By default, it returns :ref:`tooltip_text`. +Returns the tooltip text for the position ``at_position`` in control's local coordinates, which will typically appear when the cursor is resting over this control. By default, it returns :ref:`tooltip_text`. + +This method can be overridden to customize its behavior. See :ref:`_get_tooltip`. -\ **Note:** This method can be overridden to customize its behavior. If this method returns an empty :ref:`String`, no tooltip is displayed. +\ **Note:** If this method returns an empty :ref:`String`, no tooltip is displayed. .. rst-class:: classref-item-separator @@ -3182,7 +3200,7 @@ Sets :ref:`offset_right` and :ref:`offset_b void **set_focus_neighbor** **(** :ref:`Side` side, :ref:`NodePath` neighbor **)** -Sets the anchor for the specified :ref:`Side` to the **Control** at ``neighbor`` node path. A setter method for :ref:`focus_neighbor_bottom`, :ref:`focus_neighbor_left`, :ref:`focus_neighbor_right` and :ref:`focus_neighbor_top`. +Sets the focus neighbor for the specified :ref:`Side` to the **Control** at ``neighbor`` node path. A setter method for :ref:`focus_neighbor_bottom`, :ref:`focus_neighbor_left`, :ref:`focus_neighbor_right` and :ref:`focus_neighbor_top`. .. rst-class:: classref-item-separator diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 6177f19fe79..0d06c0eab26 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -19,11 +19,15 @@ Convex polygon shape resource for 2D physics. Description ----------- -2D convex polygon shape to be added as a *direct* child of a :ref:`PhysicsBody2D` or :ref:`Area2D` using a :ref:`CollisionShape2D` node. A convex polygon, whatever its shape, is internally decomposed into as many convex polygons as needed to ensure all collision checks against it are always done on convex polygons (which are faster to check). See also :ref:`CollisionPolygon2D`. +2D convex polygon shape to be added as a *direct* child of a :ref:`PhysicsBody2D` or :ref:`Area2D` using a :ref:`CollisionShape2D` node. -The main difference between a **ConvexPolygonShape2D** and a :ref:`ConcavePolygonShape2D` is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex to speed up collision detection. +The shape is a *solid* that includes all the points that it encloses, as opposed to :ref:`ConcavePolygonShape2D` which is hollow if it encloses anything. See also :ref:`CollisionPolygon2D`. -\ **Performance:** **ConvexPolygonShape2D** is faster to check collisions against compared to :ref:`ConcavePolygonShape2D`, but it is slower than primitive collision shapes such as :ref:`CircleShape2D` or :ref:`RectangleShape2D`. Its use should generally be limited to medium-sized objects that cannot have their collision accurately represented by a primitive shape. +The solid nature of the shape makes it well-suited for both detection and physics; in physics body interactions this allows depenetrating even those shapes which end up (e.g. due to high speed) fully inside the convex shape (similarly to primitive shapes, but unlike :ref:`ConcavePolygonShape2D`). The convexity limits the possible geometric shape of a single **ConvexPolygonShape2D**: it cannot be concave. + +\ **Convex decomposition:** Concave objects' collisions can be represented accurately using *several* convex shapes. This allows dynamic physics bodies to have complex concave collisions (at a performance cost). It can be achieved using several **ConvexPolygonShape2D** nodes or by using the :ref:`CollisionPolygon2D` node in Solids build mode. To generate a collision polygon from a sprite, select the :ref:`Sprite2D` node, go to the **Sprite2D** menu that appears above the viewport, and choose **Create Polygon2D Sibling**. + +\ **Performance:** **ConvexPolygonShape2D** is faster to check collisions against compared to :ref:`ConcavePolygonShape2D`, but it is slower than primitive collision shapes such as :ref:`CircleShape2D` or :ref:`RectangleShape2D`. Its use should generally be limited to medium-sized objects that cannot have their collision accurately represented by primitive shapes. .. rst-class:: classref-reftable-group @@ -69,7 +73,9 @@ Property Descriptions - void **set_points** **(** :ref:`PackedVector2Array` value **)** - :ref:`PackedVector2Array` **get_points** **(** **)** -The polygon's list of vertices. Can be in either clockwise or counterclockwise order. Only set this property with convex hull points, use :ref:`set_point_cloud` to generate a convex hull shape from concave shape points. +The polygon's list of vertices that form a convex hull. Can be in either clockwise or counterclockwise order. + +\ **Warning:** Only set this property to a list of points that actually form a convex hull. Use :ref:`set_point_cloud` to generate the convex hull of an arbitrary set of points. .. rst-class:: classref-section-separator @@ -86,7 +92,7 @@ Method Descriptions void **set_point_cloud** **(** :ref:`PackedVector2Array` point_cloud **)** -Based on the set of points provided, this creates and assigns the :ref:`points` property using the convex hull algorithm. Removing all unneeded points. See :ref:`Geometry2D.convex_hull` for details. +Based on the set of points provided, this assigns the :ref:`points` property using the convex hull algorithm, removing all unneeded points. See :ref:`Geometry2D.convex_hull` for details. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_convexpolygonshape3d.rst b/classes/class_convexpolygonshape3d.rst index 59e8b32a3f8..a0f39a2a941 100644 --- a/classes/class_convexpolygonshape3d.rst +++ b/classes/class_convexpolygonshape3d.rst @@ -19,11 +19,15 @@ Convex polygon shape resource for 3D physics. Description ----------- -3D convex polygon shape resource to be added as a *direct* child of a :ref:`PhysicsBody3D` or :ref:`Area3D` using a :ref:`CollisionShape3D` node. Unlike :ref:`ConcavePolygonShape3D`, **ConvexPolygonShape3D** cannot store concave polygon shapes. **ConvexPolygonShape3D**\ s can be manually drawn in the editor using the :ref:`CollisionPolygon3D` node. +3D convex polygon shape resource to be added as a *direct* child of a :ref:`PhysicsBody3D` or :ref:`Area3D` using a :ref:`CollisionShape3D` node. -\ **Convex decomposition:** Concave objects' collisions can be represented accurately using *several* **ConvexPolygonShape3D**\ s. This allows dynamic physics bodies to have complex concave collisions (at a performance cost). This is available in the editor by selecting the :ref:`MeshInstance3D`, going to the **Mesh** menu and choosing **Create Multiple Convex Collision Siblings**. Alternatively, :ref:`MeshInstance3D.create_multiple_convex_collisions` can be called in a script to perform this decomposition at run-time. +The shape is a *solid* that includes all the points that it encloses, as opposed to :ref:`ConcavePolygonShape3D` which is hollow if it encloses anything. See also :ref:`CollisionPolygon3D`. -\ **Performance:** **ConvexPolygonShape3D** is faster to check collisions against compared to :ref:`ConcavePolygonShape3D`, but it is slower than primitive collision shapes such as :ref:`SphereShape3D` or :ref:`BoxShape3D`. Its use should generally be limited to medium-sized objects that cannot have their collision accurately represented by a primitive shape. +The solid nature of the shape makes it well-suited for both detection and physics; in physics body interactions this allows depenetrating even those shapes which end up (e.g. due to high speed) fully inside the convex shape (similarly to primitive shapes, but unlike :ref:`ConcavePolygonShape3D` and :ref:`HeightMapShape3D`). The convexity restricts the possible geometric shape of a single **ConvexPolygonShape3D**: it cannot be concave. + +\ **Convex decomposition:** Concave objects' collisions can be represented accurately using *several* convex shapes. This allows dynamic physics bodies to have complex concave collisions (at a performance cost). It can be achieved by using several **ConvexPolygonShape3D** nodes or by using the :ref:`CollisionPolygon3D` node. To generate a collision polygon from a mesh, select the :ref:`MeshInstance3D` node, go to the **Mesh** menu that appears above the viewport and choose **Create Multiple Convex Collision Siblings**. Alternatively, :ref:`MeshInstance3D.create_multiple_convex_collisions` can be called in a script to perform this decomposition at run-time. + +\ **Performance:** **ConvexPolygonShape3D** is faster to check collisions against compared to :ref:`ConcavePolygonShape3D`, but it is slower than primitive collision shapes such as :ref:`SphereShape3D` or :ref:`BoxShape3D`. Its use should generally be limited to medium-sized objects that cannot have their collision accurately represented by primitive shapes. .. rst-class:: classref-introduction-group diff --git a/classes/class_cpuparticles3d.rst b/classes/class_cpuparticles3d.rst index f81a8d11d94..7d1fb40fc41 100644 --- a/classes/class_cpuparticles3d.rst +++ b/classes/class_cpuparticles3d.rst @@ -1662,7 +1662,7 @@ Particle system's running speed scaling ratio. A value of ``0`` can be used to p - void **set_split_scale** **(** :ref:`bool` value **)** - :ref:`bool` **get_split_scale** **(** **)** -If set to true, three different scale curves can be specified, one per scale axis. +If set to ``true``, three different scale curves can be specified, one per scale axis. .. rst-class:: classref-item-separator diff --git a/classes/class_crypto.rst b/classes/class_crypto.rst index d7c1f4baf24..a808cc1a61b 100644 --- a/classes/class_crypto.rst +++ b/classes/class_crypto.rst @@ -44,7 +44,7 @@ For now, this includes generating cryptographically secure random bytes, RSA key cert.save("user://generated.crt") # Encryption var data = "Some data" - var encrypted = crypto.encrypt(key, data.to_utf8()) + var encrypted = crypto.encrypt(key, data.to_utf8_buffer()) # Decryption var decrypted = crypto.decrypt(key, encrypted) # Signing @@ -53,7 +53,7 @@ For now, this includes generating cryptographically secure random bytes, RSA key var verified = crypto.verify(HashingContext.HASH_SHA256, data.sha256_buffer(), signature, key) # Checks assert(verified) - assert(data.to_utf8() == decrypted) + assert(data.to_utf8_buffer() == decrypted) .. code-tab:: csharp @@ -77,7 +77,7 @@ For now, this includes generating cryptographically secure random bytes, RSA key _cert.Save("user://generated.crt"); // Encryption string data = "Some data"; - byte[] encrypted = _crypto.Encrypt(_key, data.ToUtf8()); + byte[] encrypted = _crypto.Encrypt(_key, data.ToUtf8Buffer()); // Decryption byte[] decrypted = _crypto.Decrypt(_key, encrypted); // Signing @@ -86,7 +86,7 @@ For now, this includes generating cryptographically secure random bytes, RSA key bool verified = _crypto.Verify(HashingContext.HashType.Sha256, Data.Sha256Buffer(), signature, _key); // Checks Debug.Assert(verified); - Debug.Assert(data.ToUtf8() == decrypted); + Debug.Assert(data.ToUtf8Buffer() == decrypted); } } diff --git a/classes/class_csgshape3d.rst b/classes/class_csgshape3d.rst index 3203e3c58eb..9bab0290183 100644 --- a/classes/class_csgshape3d.rst +++ b/classes/class_csgshape3d.rst @@ -226,7 +226,7 @@ The operation that is performed on this shape. This is ignored for the first CSG - void **set_snap** **(** :ref:`float` value **)** - :ref:`float` **get_snap** **(** **)** -Snap makes the mesh snap to a given distance so that the faces of two meshes can be perfectly aligned. A lower value results in greater precision but may be harder to adjust. +Snap makes the mesh vertices snap to a given distance so that the faces of two meshes can be perfectly aligned. A lower value results in greater precision but may be harder to adjust. .. rst-class:: classref-item-separator diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 8ee2588b59b..389d7d33dfd 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -378,7 +378,7 @@ If the curve has no up vectors, the function sends an error to the console, and :ref:`Transform3D` **sample_baked_with_rotation** **(** :ref:`float` offset=0.0, :ref:`bool` cubic=false, :ref:`bool` apply_tilt=false **)** |const| -Similar with ``interpolate_baked()``. The the return value is ``Transform3D``, with ``origin`` as point position, ``basis.x`` as sideway vector, ``basis.y`` as up vector, ``basis.z`` as forward vector. When the curve length is 0, there is no reasonable way to calculate the rotation, all vectors aligned with global space axes. +Similar with ``interpolate_baked()``. The return value is ``Transform3D``, with ``origin`` as point position, ``basis.x`` as sideway vector, ``basis.y`` as up vector, ``basis.z`` as forward vector. When the curve length is 0, there is no reasonable way to calculate the rotation, all vectors aligned with global space axes. .. rst-class:: classref-item-separator diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 244babf075a..7e2f971f6fa 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -189,8 +189,6 @@ The keys of a dictionary can be iterated with the ``for`` keyword: \ **Note:** Erasing elements while iterating over dictionaries is **not** supported and will result in unpredictable behavior. -\ **Note:** When declaring a dictionary with ``const``, the dictionary becomes read-only. A read-only Dictionary's entries cannot be overridden at run-time. This does *not* affect nested :ref:`Array` and **Dictionary** values. - .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_diraccess.rst b/classes/class_diraccess.rst index 3a48d33231a..a06b9ee01db 100644 --- a/classes/class_diraccess.rst +++ b/classes/class_diraccess.rst @@ -195,7 +195,7 @@ Property Descriptions - void **set_include_hidden** **(** :ref:`bool` value **)** - :ref:`bool` **get_include_hidden** **(** **)** -If ``true``, hidden files are included when the navigating directory. +If ``true``, hidden files are included when navigating the directory. Affects :ref:`list_dir_begin`, :ref:`get_directories` and :ref:`get_files`. diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index d2076a05076..736eb3018d2 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -62,6 +62,8 @@ Methods +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2i` | :ref:`get_display_safe_area` **(** **)** |const| | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_keyboard_focus_screen` **(** **)** |const| | + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_name` **(** **)** |const| | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_primary_screen` **(** **)** |const| | @@ -204,6 +206,8 @@ Methods +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ScreenOrientation` | :ref:`screen_get_orientation` **(** :ref:`int` screen=-1 **)** |const| | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`screen_get_pixel` **(** :ref:`Vector2i` position **)** |const| | + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`screen_get_position` **(** :ref:`int` screen=-1 **)** |const| | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`screen_get_refresh_rate` **(** :ref:`int` screen=-1 **)** |const| | @@ -518,6 +522,14 @@ Display server supports text-to-speech. See ``tts_*`` methods. **Windows, macOS, Display server supports expanding window content to the title. See :ref:`WINDOW_FLAG_EXTEND_TO_TITLE`. **macOS** +.. _class_DisplayServer_constant_FEATURE_SCREEN_CAPTURE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_SCREEN_CAPTURE** = ``21`` + +Display server supports reading screen pixels. See :ref:`screen_get_pixel`. + .. rst-class:: classref-item-separator ---- @@ -594,7 +606,7 @@ Default landscape orientation. :ref:`ScreenOrientation` **SCREEN_PORTRAIT** = ``1`` -Default portrait orienstation. +Default portrait orientation. .. _class_DisplayServer_constant_SCREEN_REVERSE_LANDSCAPE: @@ -990,7 +1002,7 @@ The window can't be focused. No-focus window will ignore all input, except mouse :ref:`WindowFlags` **WINDOW_FLAG_POPUP** = ``5`` -Window is part of menu or :ref:`OptionButton` dropdown. This flag can't be changed when the window is visible. An active popup window will exclusively receive all input, without stealing focus from its parent. Popup windows are automatically closed when uses click outside it, or when an application is switched. Popup window must have ``transient parent`` set (see :ref:`window_set_transient`). +Window is part of menu or :ref:`OptionButton` dropdown. This flag can't be changed when the window is visible. An active popup window will exclusively receive all input, without stealing focus from its parent. Popup windows are automatically closed when uses click outside it, or when an application is switched. Popup window must have transient parent set (see :ref:`window_set_transient`). .. _class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE: @@ -1212,7 +1224,7 @@ OpenGL context (only with the GL Compatibility renderer): - Linux: ``GLXContext*`` for the window. -- MacOS: ``NSOpenGLContext*`` for the window. +- macOS: ``NSOpenGLContext*`` for the window. - Android: ``EGLContext`` for the window. @@ -1267,6 +1279,22 @@ Utterance reached a word or sentence boundary. Constants --------- +.. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS: + +.. rst-class:: classref-constant + +**SCREEN_WITH_MOUSE_FOCUS** = ``-4`` + +Represents the screen containing the mouse pointer. + +.. _class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS: + +.. rst-class:: classref-constant + +**SCREEN_WITH_KEYBOARD_FOCUS** = ``-3`` + +Represents the screen containing the window with the keyboard focus. + .. _class_DisplayServer_constant_SCREEN_PRIMARY: .. rst-class:: classref-constant @@ -1504,6 +1532,18 @@ Returns the unobscured area of the display where interactive controls should be ---- +.. _class_DisplayServer_method_get_keyboard_focus_screen: + +.. rst-class:: classref-method + +:ref:`int` **get_keyboard_focus_screen** **(** **)** |const| + +Returns the index of the screen containing the window with the keyboard focus, or the primary screen if there's no focused window. + +.. rst-class:: classref-item-separator + +---- + .. _class_DisplayServer_method_get_name: .. rst-class:: classref-method @@ -1613,7 +1653,7 @@ Adds a new checkable item with text ``label`` to the global menu with ID ``menu_ Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value. -An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using boolean OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). +An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``. @@ -1640,7 +1680,7 @@ Adds a new checkable item with text ``label`` and icon ``icon`` to the global me Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value. -An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using boolean OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). +An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``. @@ -1667,7 +1707,7 @@ Adds a new item with text ``label`` and icon ``icon`` to the global menu with ID Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value. -An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using boolean OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). +An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``. @@ -1694,7 +1734,7 @@ Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the glo Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value. -An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using boolean OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). +An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). \ **Note:** Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`global_menu_set_item_checked` for more info on how to control it. @@ -1723,7 +1763,7 @@ Adds a new item with text ``label`` to the global menu with ID ``menu_root``. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value. -An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using boolean OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). +An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``. @@ -1752,7 +1792,7 @@ Contrarily to normal binary items, multistate items can have more than two state Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value. -An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using boolean OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). +An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). \ **Note:** By default, there's no indication of the current item state, it should be changed manually. @@ -1781,7 +1821,7 @@ Adds a new radio-checkable item with text ``label`` to the global menu with ID ` Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value. -An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using boolean OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). +An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). \ **Note:** Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`global_menu_set_item_checked` for more info on how to control it. @@ -2055,7 +2095,7 @@ Returns the text of the item at index ``idx``. :ref:`String` **global_menu_get_item_tooltip** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| -Returns the tooltip associated with the specified index index ``idx``. +Returns the tooltip associated with the specified index ``idx``. \ **Note:** This method is implemented on macOS. @@ -2145,7 +2185,7 @@ Removes the item at index ``idx`` from the global menu ``menu_root``. void **global_menu_set_item_accelerator** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Key` keycode **)** -Sets the accelerator of the item at index ``idx``. ``keycode`` can be a single :ref:`Key`, or a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using boolean OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). +Sets the accelerator of the item at index ``idx``. ``keycode`` can be a single :ref:`Key`, or a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). \ **Note:** This method is implemented on macOS. @@ -2161,7 +2201,7 @@ void **global_menu_set_item_callback** **(** :ref:`String` menu_ro Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed. -\ **Note:** The ``callback`` Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the tag parameter when the menu item was created. +\ **Note:** The ``callback`` Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the ``tag`` parameter when the menu item was created. \ **Note:** This method is implemented on macOS. @@ -2249,7 +2289,7 @@ void **global_menu_set_item_key_callback** **(** :ref:`String` men Sets the callback of the item at index ``idx``. Callback is emitted when its accelerator is activated. -\ **Note:** The ``key_callback`` Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the tag parameter when the menu item was created. +\ **Note:** The ``key_callback`` Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the ``tag`` parameter when the menu item was created. \ **Note:** This method is implemented on macOS. @@ -2551,7 +2591,7 @@ Returns the current mouse mode. See also :ref:`mouse_set_mode` **mouse_get_position** **(** **)** |const| -Returns the mouse cursor's current position. +Returns the mouse cursor's current position in screen coordinates. .. rst-class:: classref-item-separator @@ -2638,6 +2678,22 @@ Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientat ---- +.. _class_DisplayServer_method_screen_get_pixel: + +.. rst-class:: classref-method + +:ref:`Color` **screen_get_pixel** **(** :ref:`Vector2i` position **)** |const| + +Returns color of the display pixel at the ``position``. + +\ **Note:** This method is implemented on Linux (X11), macOS, and Windows. + +\ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color. + +.. rst-class:: classref-item-separator + +---- + .. _class_DisplayServer_method_screen_get_position: .. rst-class:: classref-method @@ -2765,7 +2821,7 @@ Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation` image **)** -Sets the window icon (usually displayed in the top-left corner) in the operating system's *native* format. To use icons in the operating system's native format, use :ref:`set_native_icon` instead. +Sets the window icon (usually displayed in the top-left corner) with an :ref:`Image`. To use icons in the operating system's native format, use :ref:`set_native_icon` instead. .. rst-class:: classref-item-separator @@ -2855,7 +2911,7 @@ Each :ref:`Dictionary` contains two :ref:`String - ``language`` is language code in ``lang_Variant`` format. ``lang`` part is a 2 or 3-letter code based on the ISO-639 standard, in lowercase. And ``Variant`` part is an engine dependent string describing country, region or/and dialect. -Note that Godot depends on system libraries for text-to-speech functionality. These libraries are installed by default on Windows and MacOS, but not on all Linux distributions. If they are not present, this method will return an empty list. This applies to both Godot users on Linux, as well as end-users on Linux running Godot games that use text-to-speech. +Note that Godot depends on system libraries for text-to-speech functionality. These libraries are installed by default on Windows and macOS, but not on all Linux distributions. If they are not present, this method will return an empty list. This applies to both Godot users on Linux, as well as end-users on Linux running Godot games that use text-to-speech. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows. @@ -2941,9 +2997,9 @@ void **tts_set_utterance_callback** **(** :ref:`TTSUtteranceEvent`, :ref:`TTS_UTTERANCE_ENDED`, and :ref:`TTS_UTTERANCE_CANCELED` callable's method should take one :ref:`int` parameter, the utterance id. +- :ref:`TTS_UTTERANCE_STARTED`, :ref:`TTS_UTTERANCE_ENDED`, and :ref:`TTS_UTTERANCE_CANCELED` callable's method should take one :ref:`int` parameter, the utterance ID. -- :ref:`TTS_UTTERANCE_BOUNDARY` callable's method should take two :ref:`int` parameters, the index of the character and the utterance id. +- :ref:`TTS_UTTERANCE_BOUNDARY` callable's method should take two :ref:`int` parameters, the index of the character and the utterance ID. \ **Note:** The granularity of the boundary callbacks is engine dependent. diff --git a/classes/class_dtlsserver.rst b/classes/class_dtlsserver.rst index c888ec296f5..69da23ef98b 100644 --- a/classes/class_dtlsserver.rst +++ b/classes/class_dtlsserver.rst @@ -43,8 +43,8 @@ Below a small example of how to use it: func _process(delta): while server.is_connection_available(): - var peer : PacketPeerUDP = server.take_connection() - var dtls_peer : PacketPeerDTLS = dtls.take_connection(peer) + var peer: PacketPeerUDP = server.take_connection() + var dtls_peer: PacketPeerDTLS = dtls.take_connection(peer) if dtls_peer.get_status() != PacketPeerDTLS.STATUS_HANDSHAKING: continue # It is normal that 50% of the connections fails due to cookie exchange. print("Peer connected!") @@ -55,7 +55,7 @@ Below a small example of how to use it: if p.get_status() == PacketPeerDTLS.STATUS_CONNECTED: while p.get_available_packet_count() > 0: print("Received message from client: %s" % p.get_packet().get_string_from_utf8()) - p.put_packet("Hello DTLS client".to_utf8()) + p.put_packet("Hello DTLS client".to_utf8_buffer()) .. code-tab:: csharp @@ -98,7 +98,7 @@ Below a small example of how to use it: while (p.GetAvailablePacketCount() > 0) { GD.Print($"Received Message From Client: {p.GetPacket().GetStringFromUtf8()}"); - p.PutPacket("Hello DTLS Client".ToUtf8()); + p.PutPacket("Hello DTLS Client".ToUtf8Buffer()); } } } @@ -128,7 +128,7 @@ Below a small example of how to use it: if dtls.get_status() == PacketPeerDTLS.STATUS_CONNECTED: if !connected: # Try to contact server - dtls.put_packet("The answer is... 42!".to_utf8()) + dtls.put_packet("The answer is... 42!".to_utf8_buffer()) while dtls.get_available_packet_count() > 0: print("Connected: %s" % dtls.get_packet().get_string_from_utf8()) connected = true @@ -159,7 +159,7 @@ Below a small example of how to use it: if (!_connected) { // Try to contact server - _dtls.PutPacket("The Answer Is..42!".ToUtf8()); + _dtls.PutPacket("The Answer Is..42!".ToUtf8Buffer()); } while (_dtls.GetAvailablePacketCount() > 0) { diff --git a/classes/class_editorexportplatform.rst b/classes/class_editorexportplatform.rst index 3cabea5eb6d..3a1d5f211ca 100644 --- a/classes/class_editorexportplatform.rst +++ b/classes/class_editorexportplatform.rst @@ -12,6 +12,8 @@ EditorExportPlatform **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +**Inherited By:** :ref:`EditorExportPlatformAndroid`, :ref:`EditorExportPlatformIOS`, :ref:`EditorExportPlatformMacOS`, :ref:`EditorExportPlatformPC`, :ref:`EditorExportPlatformWeb` + Identifies a supported export platform, and internally provides the functionality of exporting to that platform. .. rst-class:: classref-introduction-group diff --git a/classes/class_editorexportplatformandroid.rst b/classes/class_editorexportplatformandroid.rst new file mode 100644 index 00000000000..b47087b739b --- /dev/null +++ b/classes/class_editorexportplatformandroid.rst @@ -0,0 +1,2708 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/platform/android/doc_classes/EditorExportPlatformAndroid.xml. + +.. _class_EditorExportPlatformAndroid: + +EditorExportPlatformAndroid +=========================== + +**Inherits:** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` + +Exporter for Android. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Exporting for Android <../tutorials/export/exporting_for_android>` + +- :doc:`Custom builds for Android <../tutorials/export/android_custom_build>` + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`apk_expansion/SALT` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`apk_expansion/enable` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`apk_expansion/public_key` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`architectures/arm64-v8a` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`architectures/armeabi-v7a` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`architectures/x86` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`architectures/x86_64` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`command_line/extra_args` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/debug` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/release` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`gradle_build/export_format` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`gradle_build/min_sdk` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`gradle_build/target_sdk` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gradle_build/use_gradle_build` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`graphics/opengl_debug` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`keystore/debug` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`keystore/debug_password` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`keystore/debug_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`keystore/release` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`keystore/release_password` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`keystore/release_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`launcher_icons/adaptive_background_432x432` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`launcher_icons/adaptive_foreground_432x432` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`launcher_icons/main_192x192` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`package/app_category` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`package/exclude_from_recents` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`package/name` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`package/retain_data_on_uninstall` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`package/signed` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`package/unique_name` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/access_checkin_properties` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/access_coarse_location` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/access_fine_location` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/access_location_extra_commands` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/access_mock_location` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/access_network_state` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/access_surface_flinger` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/access_wifi_state` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/account_manager` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/add_voicemail` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/authenticate_accounts` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/battery_stats` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bind_accessibility_service` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bind_appwidget` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bind_device_admin` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bind_input_method` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bind_nfc_service` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bind_notification_listener_service` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bind_print_service` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bind_remoteviews` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bind_text_service` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bind_vpn_service` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bind_wallpaper` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bluetooth` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bluetooth_admin` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/bluetooth_privileged` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/brick` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/broadcast_package_removed` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/broadcast_sms` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/broadcast_sticky` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/broadcast_wap_push` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/call_phone` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/call_privileged` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/camera` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/capture_audio_output` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/capture_secure_video_output` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/capture_video_output` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/change_component_enabled_state` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/change_configuration` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/change_network_state` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/change_wifi_multicast_state` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/change_wifi_state` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/clear_app_cache` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/clear_app_user_data` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/control_location_updates` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`permissions/custom_permissions` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/delete_cache_files` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/delete_packages` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/device_power` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/diagnostic` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/disable_keyguard` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/dump` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/expand_status_bar` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/factory_test` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/flashlight` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/force_back` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/get_accounts` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/get_package_size` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/get_tasks` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/get_top_activity_info` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/global_search` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/hardware_test` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/inject_events` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/install_location_provider` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/install_packages` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/install_shortcut` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/internal_system_window` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/internet` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/kill_background_processes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/location_hardware` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/manage_accounts` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/manage_app_tokens` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/manage_documents` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/manage_external_storage` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/master_clear` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/media_content_control` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/modify_audio_settings` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/modify_phone_state` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/mount_format_filesystems` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/mount_unmount_filesystems` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/nfc` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/persistent_activity` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/process_outgoing_calls` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_calendar` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_call_log` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_contacts` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_external_storage` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_frame_buffer` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_history_bookmarks` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_input_state` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_logs` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_phone_state` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_profile` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_sms` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_social_stream` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_sync_settings` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_sync_stats` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/read_user_dictionary` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/reboot` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/receive_boot_completed` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/receive_mms` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/receive_sms` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/receive_wap_push` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/record_audio` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/reorder_tasks` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/restart_packages` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/send_respond_via_message` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/send_sms` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/set_activity_watcher` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/set_alarm` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/set_always_finish` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/set_animation_scale` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/set_debug_app` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/set_orientation` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/set_pointer_speed` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/set_preferred_applications` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/set_process_limit` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/set_time` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/set_time_zone` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/set_wallpaper` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/set_wallpaper_hints` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/signal_persistent_processes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/status_bar` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/subscribed_feeds_read` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/subscribed_feeds_write` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/system_alert_window` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/transmit_ir` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/uninstall_shortcut` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/update_device_stats` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/use_credentials` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/use_sip` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/vibrate` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/wake_lock` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_apn_settings` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_calendar` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_call_log` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_contacts` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_external_storage` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_gservices` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_history_bookmarks` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_profile` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_secure_settings` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_settings` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_sms` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_social_stream` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_sync_settings` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/write_user_dictionary` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`screen/immersive_mode` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`screen/support_large` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`screen/support_normal` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`screen/support_small` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`screen/support_xlarge` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`user_data_backup/allow` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`version/code` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`version/name` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`xr_features/hand_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`xr_features/hand_tracking_frequency` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`xr_features/passthrough` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`xr_features/xr_mode` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_EditorExportPlatformAndroid_property_apk_expansion/SALT: + +.. rst-class:: classref-property + +:ref:`String` **apk_expansion/SALT** + +Array of random bytes that the licensing Policy uses to create an `Obfuscator `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_apk_expansion/enable: + +.. rst-class:: classref-property + +:ref:`bool` **apk_expansion/enable** + +If ``true``, project resources are stored in the separate APK expansion file, instead APK. + +\ **Note:** APK expansion should be enabled to use PCK encryption. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_apk_expansion/public_key: + +.. rst-class:: classref-property + +:ref:`String` **apk_expansion/public_key** + +Base64 encoded RSA public key for your publisher account, available from the profile page on the "Play Console". + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_architectures/arm64-v8a: + +.. rst-class:: classref-property + +:ref:`bool` **architectures/arm64-v8a** + +If ``true``, ``arm64`` binaries are included into exported project. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_architectures/armeabi-v7a: + +.. rst-class:: classref-property + +:ref:`bool` **architectures/armeabi-v7a** + +If ``true``, ``arm32`` binaries are included into exported project. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_architectures/x86: + +.. rst-class:: classref-property + +:ref:`bool` **architectures/x86** + +If ``true``, ``x86_32`` binaries are included into exported project. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_architectures/x86_64: + +.. rst-class:: classref-property + +:ref:`bool` **architectures/x86_64** + +If ``true``, ``x86_64`` binaries are included into exported project. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_command_line/extra_args: + +.. rst-class:: classref-property + +:ref:`String` **command_line/extra_args** + +A list of additional command line arguments, exported project will receive when started. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_custom_template/debug: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/debug** + +Path to the custom export template. If left empty, default template is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_custom_template/release: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/release** + +Path to the custom export template. If left empty, default template is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_gradle_build/export_format: + +.. rst-class:: classref-property + +:ref:`int` **gradle_build/export_format** + +Export format for Gradle build. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_gradle_build/min_sdk: + +.. rst-class:: classref-property + +:ref:`String` **gradle_build/min_sdk** + +Minimal Android SDK version for Gradle build. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_gradle_build/target_sdk: + +.. rst-class:: classref-property + +:ref:`String` **gradle_build/target_sdk** + +Target Android SDK version for Gradle build. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_gradle_build/use_gradle_build: + +.. rst-class:: classref-property + +:ref:`bool` **gradle_build/use_gradle_build** + +If ``true``, Gradle build is used instead of pre-built APK. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_graphics/opengl_debug: + +.. rst-class:: classref-property + +:ref:`bool` **graphics/opengl_debug** + +If ``true``, OpenGL ES debug context will be created (additional runtime checking, validation, and logging). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_keystore/debug: + +.. rst-class:: classref-property + +:ref:`String` **keystore/debug** + +Path of the debug keystore file. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_keystore/debug_password: + +.. rst-class:: classref-property + +:ref:`String` **keystore/debug_password** + +Password for the debug keystore file. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_keystore/debug_user: + +.. rst-class:: classref-property + +:ref:`String` **keystore/debug_user** + +User name for the debug keystore file. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_keystore/release: + +.. rst-class:: classref-property + +:ref:`String` **keystore/release** + +Path of the release keystore file. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_keystore/release_password: + +.. rst-class:: classref-property + +:ref:`String` **keystore/release_password** + +Password for the release keystore file. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_keystore/release_user: + +.. rst-class:: classref-property + +:ref:`String` **keystore/release_user** + +User name for the release keystore file. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_launcher_icons/adaptive_background_432x432: + +.. rst-class:: classref-property + +:ref:`String` **launcher_icons/adaptive_background_432x432** + +Background layer of the application adaptive icon file. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_launcher_icons/adaptive_foreground_432x432: + +.. rst-class:: classref-property + +:ref:`String` **launcher_icons/adaptive_foreground_432x432** + +Foreground layer of the application adaptive icon file. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_launcher_icons/main_192x192: + +.. rst-class:: classref-property + +:ref:`String` **launcher_icons/main_192x192** + +Application icon file. If left empty, project icon is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_package/app_category: + +.. rst-class:: classref-property + +:ref:`int` **package/app_category** + +Application category for the Play Store. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_package/exclude_from_recents: + +.. rst-class:: classref-property + +:ref:`bool` **package/exclude_from_recents** + +If ``true``, task initiated by main activity will be excluded from the list of recently used applications. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_package/name: + +.. rst-class:: classref-property + +:ref:`String` **package/name** + +Name of the application. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_package/retain_data_on_uninstall: + +.. rst-class:: classref-property + +:ref:`bool` **package/retain_data_on_uninstall** + +If ``true``, when the user uninstalls an app, a prompt to keep the app's data will be shown. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_package/signed: + +.. rst-class:: classref-property + +:ref:`bool` **package/signed** + +If ``true``, package signing is enabled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_package/unique_name: + +.. rst-class:: classref-property + +:ref:`String` **package/unique_name** + +Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters (``A-Z``, ``a-z``, and ``0-9``), hyphens (``-``), and periods (``.``). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/access_checkin_properties: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/access_checkin_properties** + +Allows read/write access to the "properties" table in the checkin database. See `ACCESS_CHECKIN_PROPERTIES `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/access_coarse_location: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/access_coarse_location** + +Allows access to the approximate location information. See `ACCESS_COARSE_LOCATION `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/access_fine_location: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/access_fine_location** + +Allows access to the precise location information. See `ACCESS_FINE_LOCATION `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/access_location_extra_commands: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/access_location_extra_commands** + +Allows access to the extra location provider commands. See `ACCESS_LOCATION_EXTRA_COMMANDS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/access_mock_location: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/access_mock_location** + +Allows an application to create mock location providers for testing. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/access_network_state: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/access_network_state** + +Allows access to the information about networks. See `ACCESS_NETWORK_STATE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/access_surface_flinger: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/access_surface_flinger** + +Allows an application to use SurfaceFlinger's low level features. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/access_wifi_state: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/access_wifi_state** + +Allows access to the information about Wi-Fi networks. See `ACCESS_WIFI_STATE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/account_manager: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/account_manager** + +Allows applications to call into AccountAuthenticators. See `ACCOUNT_MANAGER `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/add_voicemail: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/add_voicemail** + +Allows an application to add voicemails into the system. See `ADD_VOICEMAIL `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/authenticate_accounts: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/authenticate_accounts** + +Allows an application to act as an AccountAuthenticator for the AccountManager. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/battery_stats: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/battery_stats** + +Allows an application to collect battery statistics. Sett `BATTERY_STATS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bind_accessibility_service: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bind_accessibility_service** + +Must be required by an AccessibilityService, to ensure that only the system can bind to it. See `BIND_ACCESSIBILITY_SERVICE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bind_appwidget: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bind_appwidget** + +Allows an application to tell the AppWidget service which application can access AppWidget's data. See `BIND_APPWIDGET `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bind_device_admin: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bind_device_admin** + +Must be required by device administration receiver, to ensure that only the system can interact with it. See `BIND_DEVICE_ADMIN `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bind_input_method: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bind_input_method** + +Must be required by an InputMethodService, to ensure that only the system can bind to it. See `BIND_INPUT_METHOD `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bind_nfc_service: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bind_nfc_service** + +Must be required by a HostApduService or OffHostApduService to ensure that only the system can bind to it. See `BIND_NFC_SERVICE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bind_notification_listener_service: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bind_notification_listener_service** + +Must be required by an NotificationListenerService, to ensure that only the system can bind to it. See `BIND_NOTIFICATION_LISTENER_SERVICE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bind_print_service: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bind_print_service** + +Must be required by a PrintService, to ensure that only the system can bind to it. See `BIND_PRINT_SERVICE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bind_remoteviews: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bind_remoteviews** + +Must be required by a RemoteViewsService, to ensure that only the system can bind to it. See `BIND_REMOTEVIEWS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bind_text_service: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bind_text_service** + +Must be required by a TextService (e.g. SpellCheckerService) to ensure that only the system can bind to it. See `BIND_TEXT_SERVICE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bind_vpn_service: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bind_vpn_service** + +Must be required by a VpnService, to ensure that only the system can bind to it. See `BIND_VPN_SERVICE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bind_wallpaper: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bind_wallpaper** + +Must be required by a WallpaperService, to ensure that only the system can bind to it. See `BIND_WALLPAPER `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bluetooth: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bluetooth** + +Allows applications to connect to paired bluetooth devices. See `BLUETOOTH `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bluetooth_admin: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bluetooth_admin** + +Allows applications to discover and pair bluetooth devices. See `BLUETOOTH_ADMIN `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/bluetooth_privileged: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/bluetooth_privileged** + +Allows applications to pair bluetooth devices without user interaction, and to allow or disallow phonebook access or message access. See `BLUETOOTH_PRIVILEGED `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/brick: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/brick** + +Required to be able to disable the device (very dangerous!). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/broadcast_package_removed: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/broadcast_package_removed** + +Allows an application to broadcast a notification that an application package has been removed. See `BROADCAST_PACKAGE_REMOVED `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/broadcast_sms: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/broadcast_sms** + +Allows an application to broadcast an SMS receipt notification. See `BROADCAST_SMS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/broadcast_sticky: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/broadcast_sticky** + +Allows an application to broadcast sticky intents. See `BROADCAST_STICKY `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/broadcast_wap_push: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/broadcast_wap_push** + +Allows an application to broadcast a WAP PUSH receipt notification. See `BROADCAST_WAP_PUSH `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/call_phone: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/call_phone** + +Allows an application to initiate a phone call without going through the Dialer user interface. See `CALL_PHONE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/call_privileged: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/call_privileged** + +Allows an application to call any phone number, including emergency numbers, without going through the Dialer user interface. See `CALL_PRIVILEGED `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/camera: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/camera** + +Required to be able to access the camera device. See `CAMERA `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/capture_audio_output: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/capture_audio_output** + +Allows an application to capture audio output. See `CAPTURE_AUDIO_OUTPUT `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/capture_secure_video_output: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/capture_secure_video_output** + +Allows an application to capture secure video output. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/capture_video_output: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/capture_video_output** + +Allows an application to capture video output. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/change_component_enabled_state: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/change_component_enabled_state** + +Allows an application to change whether an application component (other than its own) is enabled or not. See `CHANGE_COMPONENT_ENABLED_STATE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/change_configuration: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/change_configuration** + +Allows an application to modify the current configuration, such as locale. See `CHANGE_CONFIGURATION `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/change_network_state: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/change_network_state** + +Allows applications to change network connectivity state. See `CHANGE_NETWORK_STATE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/change_wifi_multicast_state: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/change_wifi_multicast_state** + +Allows applications to enter Wi-Fi Multicast mode. See `CHANGE_WIFI_MULTICAST_STATE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/change_wifi_state: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/change_wifi_state** + +Allows applications to change Wi-Fi connectivity state. See `CHANGE_WIFI_STATE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/clear_app_cache: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/clear_app_cache** + +Allows an application to clear the caches of all installed applications on the device. See `CLEAR_APP_CACHE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/clear_app_user_data: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/clear_app_user_data** + +Allows an application to clear user data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/control_location_updates: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/control_location_updates** + +Allows enabling/disabling location update notifications from the radio. See `CONTROL_LOCATION_UPDATES `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/custom_permissions: + +.. rst-class:: classref-property + +:ref:`PackedStringArray` **permissions/custom_permissions** + +Array of custom permission strings. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/delete_cache_files: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/delete_cache_files** + +Deprecated. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/delete_packages: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/delete_packages** + +Allows an application to delete packages. See `DELETE_PACKAGES `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/device_power: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/device_power** + +Allows low-level access to power management. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/diagnostic: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/diagnostic** + +Allows applications to RW to diagnostic resources. See `DIAGNOSTIC `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/disable_keyguard: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/disable_keyguard** + +Allows applications to disable the keyguard if it is not secure. See `DISABLE_KEYGUARD `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/dump: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/dump** + +Allows an application to retrieve state dump information from system services. See `DUMP `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/expand_status_bar: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/expand_status_bar** + +Allows an application to expand or collapse the status bar. See `EXPAND_STATUS_BAR `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/factory_test: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/factory_test** + +Run as a manufacturer test application, running as the root user. See `FACTORY_TEST `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/flashlight: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/flashlight** + +Allows access to the flashlight. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/force_back: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/force_back** + +Allows an application to force a BACK operation on whatever is the top activity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/get_accounts: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/get_accounts** + +Allows access to the list of accounts in the Accounts Service. See `GET_ACCOUNTS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/get_package_size: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/get_package_size** + +Allows an application to find out the space used by any package. See `GET_PACKAGE_SIZE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/get_tasks: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/get_tasks** + +Deprecated in API level 21. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/get_top_activity_info: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/get_top_activity_info** + +Allows an application to retrieve private information about the current top activity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/global_search: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/global_search** + +Used on content providers to allow the global search system to access their data. See `GLOBAL_SEARCH `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/hardware_test: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/hardware_test** + +Allows access to hardware peripherals. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/inject_events: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/inject_events** + +Allows an application to inject user events (keys, touch, trackball) into the event stream and deliver them to ANY window. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/install_location_provider: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/install_location_provider** + +Allows an application to install a location provider into the Location Manager. See `INSTALL_LOCATION_PROVIDER `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/install_packages: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/install_packages** + +Allows an application to install packages. See `INSTALL_PACKAGES `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/install_shortcut: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/install_shortcut** + +Allows an application to install a shortcut in Launcher. See `INSTALL_SHORTCUT `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/internal_system_window: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/internal_system_window** + +Allows an application to open windows that are for use by parts of the system user interface. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/internet: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/internet** + +Allows applications to open network sockets. See `INTERNET `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/kill_background_processes: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/kill_background_processes** + +Allows an application to call ActivityManager.killBackgroundProcesses(String). See `KILL_BACKGROUND_PROCESSES `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/location_hardware: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/location_hardware** + +Allows an application to use location features in hardware, such as the geofencing api. See `LOCATION_HARDWARE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/manage_accounts: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/manage_accounts** + +Allows an application to manage the list of accounts in the AccountManager. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/manage_app_tokens: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/manage_app_tokens** + +Allows an application to manage (create, destroy, Z-order) application tokens in the window manager. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/manage_documents: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/manage_documents** + +Allows an application to manage access to documents, usually as part of a document picker. See `MANAGE_DOCUMENTS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/manage_external_storage: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/manage_external_storage** + +Allows an application a broad access to external storage in scoped storage. See `MANAGE_EXTERNAL_STORAGE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/master_clear: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/master_clear** + +See `MASTER_CLEAR `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/media_content_control: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/media_content_control** + +Allows an application to know what content is playing and control its playback. See `MEDIA_CONTENT_CONTROL `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/modify_audio_settings: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/modify_audio_settings** + +Allows an application to modify global audio settings. See `MODIFY_AUDIO_SETTINGS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/modify_phone_state: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/modify_phone_state** + +Allows modification of the telephony state - power on, mmi, etc. Does not include placing calls. See `MODIFY_PHONE_STATE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/mount_format_filesystems: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/mount_format_filesystems** + +Allows formatting file systems for removable storage. See `MOUNT_FORMAT_FILESYSTEMS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/mount_unmount_filesystems: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/mount_unmount_filesystems** + +Allows mounting and unmounting file systems for removable storage. See `MOUNT_UNMOUNT_FILESYSTEMS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/nfc: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/nfc** + +Allows applications to perform I/O operations over NFC. See `NFC `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/persistent_activity: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/persistent_activity** + +Allow an application to make its activities persistent. + +Deprecated in API level 15. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/process_outgoing_calls: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/process_outgoing_calls** + +Allows an application to see the number being dialed during an outgoing call with the option to redirect the call to a different number or abort the call altogether. See `PROCESS_OUTGOING_CALLS `__. + +Deprecated in API level 29. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_calendar: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_calendar** + +Allows an application to read the user's calendar data. See `READ_CALENDAR `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_call_log: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_call_log** + +Allows an application to read the user's call log. See `READ_CALL_LOG `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_contacts: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_contacts** + +Allows an application to read the user's contacts data. See `READ_CONTACTS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_external_storage: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_external_storage** + +Allows an application to read from external storage. See `READ_EXTERNAL_STORAGE `__. + +Deprecated in API level 33. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_frame_buffer: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_frame_buffer** + +Allows an application to take screen shots and more generally get access to the frame buffer data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_history_bookmarks: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_history_bookmarks** + +Allows an application to read (but not write) the user's browsing history and bookmarks. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_input_state: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_input_state** + +Deprecated in API level 16. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_logs: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_logs** + +Allows an application to read the low-level system log files. See `READ_LOGS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_phone_state: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_phone_state** + +Allows read only access to phone state. See `READ_PHONE_STATE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_profile: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_profile** + +Allows an application to read the user's personal profile data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_sms: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_sms** + +Allows an application to read SMS messages. See `READ_SMS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_social_stream: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_social_stream** + +Allows an application to read from the user's social stream. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_sync_settings: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_sync_settings** + +Allows applications to read the sync settings. See `READ_SYNC_SETTINGS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_sync_stats: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_sync_stats** + +Allows applications to read the sync stats. See `READ_SYNC_STATS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/read_user_dictionary: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/read_user_dictionary** + +Allows an application to read the user dictionary. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/reboot: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/reboot** + +Required to be able to reboot the device. See `REBOOT `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/receive_boot_completed: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/receive_boot_completed** + +Allows an application to receive the Intent.ACTION_BOOT_COMPLETED that is broadcast after the system finishes booting. See `RECEIVE_BOOT_COMPLETED `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/receive_mms: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/receive_mms** + +Allows an application to monitor incoming MMS messages. See `RECEIVE_MMS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/receive_sms: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/receive_sms** + +Allows an application to receive SMS messages. See `RECEIVE_SMS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/receive_wap_push: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/receive_wap_push** + +Allows an application to receive WAP push messages. See `RECEIVE_WAP_PUSH `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/record_audio: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/record_audio** + +Allows an application to record audio. See `RECORD_AUDIO `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/reorder_tasks: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/reorder_tasks** + +Allows an application to change the Z-order of tasks. See `REORDER_TASKS < https://developer.android.com/reference/android/Manifest.permission#REORDER_TASKS>`__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/restart_packages: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/restart_packages** + +Deprecated in API level 15. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/send_respond_via_message: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/send_respond_via_message** + +Allows an application (Phone) to send a request to other applications to handle the respond-via-message action during incoming calls. See `SEND_RESPOND_VIA_MESSAGE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/send_sms: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/send_sms** + +Allows an application to send SMS messages. See `SEND_SMS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/set_activity_watcher: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/set_activity_watcher** + +Allows an application to watch and control how activities are started globally in the system. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/set_alarm: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/set_alarm** + +Allows an application to broadcast an Intent to set an alarm for the user. See `SET_ALARM `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/set_always_finish: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/set_always_finish** + +Allows an application to control whether activities are immediately finished when put in the background. See `SET_ALWAYS_FINISH `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/set_animation_scale: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/set_animation_scale** + +Allows to modify the global animation scaling factor. See `SET_ANIMATION_SCALE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/set_debug_app: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/set_debug_app** + +Configure an application for debugging. See `SET_DEBUG_APP `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/set_orientation: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/set_orientation** + +Allows low-level access to setting the orientation (actually rotation) of the screen. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/set_pointer_speed: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/set_pointer_speed** + +Allows low-level access to setting the pointer speed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/set_preferred_applications: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/set_preferred_applications** + +Deprecated in API level 15. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/set_process_limit: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/set_process_limit** + +Allows an application to set the maximum number of (not needed) application processes that can be running. See `SET_PROCESS_LIMIT `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/set_time: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/set_time** + +Allows applications to set the system time directly. See `SET_TIME `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/set_time_zone: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/set_time_zone** + +Allows applications to set the system time zone directly. See `SET_TIME_ZONE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/set_wallpaper: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/set_wallpaper** + +Allows applications to set the wallpaper. See `SET_WALLPAPER `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/set_wallpaper_hints: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/set_wallpaper_hints** + +Allows applications to set the wallpaper hints. See `SET_WALLPAPER_HINTS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/signal_persistent_processes: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/signal_persistent_processes** + +Allow an application to request that a signal be sent to all persistent processes. See `SIGNAL_PERSISTENT_PROCESSES `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/status_bar: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/status_bar** + +Allows an application to open, close, or disable the status bar and its icons. See `STATUS_BAR `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/subscribed_feeds_read: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/subscribed_feeds_read** + +Allows an application to allow access the subscribed feeds ContentProvider. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/subscribed_feeds_write: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/subscribed_feeds_write** + +Deprecated. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/system_alert_window: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/system_alert_window** + +Allows an app to create windows using the type WindowManager.LayoutParams.TYPE_APPLICATION_OVERLAY, shown on top of all other apps. See `SYSTEM_ALERT_WINDOW `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/transmit_ir: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/transmit_ir** + +Allows using the device's IR transmitter, if available. See `TRANSMIT_IR `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/uninstall_shortcut: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/uninstall_shortcut** + +Deprecated. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/update_device_stats: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/update_device_stats** + +Allows an application to update device statistics. See `UPDATE_DEVICE_STATS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/use_credentials: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/use_credentials** + +Allows an application to request authtokens from the AccountManager. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/use_sip: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/use_sip** + +Allows an application to use SIP service. See `USE_SIP `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/vibrate: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/vibrate** + +Allows access to the vibrator. See `VIBRATE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/wake_lock: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/wake_lock** + +Allows using PowerManager WakeLocks to keep processor from sleeping or screen from dimming. See `WAKE_LOCK `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_apn_settings: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_apn_settings** + +Allows applications to write the apn settings and read sensitive fields of an existing apn settings like user and password. See `WRITE_APN_SETTINGS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_calendar: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_calendar** + +Allows an application to write the user's calendar data. See `WRITE_CALENDAR `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_call_log: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_call_log** + +Allows an application to write (but not read) the user's call log data. See `WRITE_CALL_LOG `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_contacts: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_contacts** + +Allows an application to write the user's contacts data. See `WRITE_CONTACTS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_external_storage: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_external_storage** + +Allows an application to write to external storage. See `WRITE_EXTERNAL_STORAGE `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_gservices: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_gservices** + +Allows an application to modify the Google service map. See `WRITE_GSERVICES `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_history_bookmarks: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_history_bookmarks** + +Allows an application to write (but not read) the user's browsing history and bookmarks. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_profile: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_profile** + +Allows an application to write (but not read) the user's personal profile data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_secure_settings: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_secure_settings** + +Allows an application to read or write the secure system settings. See `WRITE_SECURE_SETTINGS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_settings: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_settings** + +Allows an application to read or write the system settings. See `WRITE_SETTINGS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_sms: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_sms** + +Allows an application to write SMS messages. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_social_stream: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_social_stream** + +Allows an application to write (but not read) the user's social stream data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_sync_settings: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_sync_settings** + +Allows applications to write the sync settings. See `WRITE_SYNC_SETTINGS `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_permissions/write_user_dictionary: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/write_user_dictionary** + +Allows an application to write to the user dictionary. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_screen/immersive_mode: + +.. rst-class:: classref-property + +:ref:`bool` **screen/immersive_mode** + +If ``true``, hides navigation and status bar. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_screen/support_large: + +.. rst-class:: classref-property + +:ref:`bool` **screen/support_large** + +Indicates whether the application supports larger screen form-factors. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_screen/support_normal: + +.. rst-class:: classref-property + +:ref:`bool` **screen/support_normal** + +Indicates whether an application supports the "normal" screen form-factors. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_screen/support_small: + +.. rst-class:: classref-property + +:ref:`bool` **screen/support_small** + +Indicates whether the application supports smaller screen form-factors. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_screen/support_xlarge: + +.. rst-class:: classref-property + +:ref:`bool` **screen/support_xlarge** + +Indicates whether the application supports extra large screen form-factors. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_user_data_backup/allow: + +.. rst-class:: classref-property + +:ref:`bool` **user_data_backup/allow** + +If ``true``, allows the application to participate in the backup and restore infrastructure. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_version/code: + +.. rst-class:: classref-property + +:ref:`int` **version/code** + +Machine-readable application version. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_version/name: + +.. rst-class:: classref-property + +:ref:`String` **version/name** + +Application version visible to the user. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_xr_features/hand_tracking: + +.. rst-class:: classref-property + +:ref:`int` **xr_features/hand_tracking** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_xr_features/hand_tracking_frequency: + +.. rst-class:: classref-property + +:ref:`int` **xr_features/hand_tracking_frequency** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_xr_features/passthrough: + +.. rst-class:: classref-property + +:ref:`int` **xr_features/passthrough** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_xr_features/xr_mode: + +.. rst-class:: classref-property + +:ref:`int` **xr_features/xr_mode** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_editorexportplatformios.rst b/classes/class_editorexportplatformios.rst new file mode 100644 index 00000000000..3ba850fea37 --- /dev/null +++ b/classes/class_editorexportplatformios.rst @@ -0,0 +1,828 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/platform/ios/doc_classes/EditorExportPlatformIOS.xml. + +.. _class_EditorExportPlatformIOS: + +EditorExportPlatformIOS +======================= + +**Inherits:** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` + +Exporter for iOS. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Exporting for iOS <../tutorials/export/exporting_for_ios>` + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/app_store_team_id` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/bundle_identifier` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/code_sign_identity_debug` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/code_sign_identity_release` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/export_method_debug` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/export_method_release` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/icon_interpolation` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/launch_screens_interpolation` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/provisioning_profile_uuid_debug` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/provisioning_profile_uuid_release` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/short_version` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/signature` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/targeted_device_family` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/version` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`architectures/arm64` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`capabilities/access_wifi` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`capabilities/push_notifications` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/debug` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/release` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/app_store_1024x1024` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ipad_152x152` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ipad_167x167` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ipad_76x76` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/iphone_120x120` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/iphone_180x180` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_40x40` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_60x60` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/settings_58x58` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/settings_87x87` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/spotlight_40x40` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/spotlight_80x80` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`landscape_launch_screens/ipad_1024x768` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`landscape_launch_screens/ipad_2048x1536` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`landscape_launch_screens/iphone_2208x1242` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`landscape_launch_screens/iphone_2436x1125` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/ipad_1536x2048` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/ipad_768x1024` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/iphone_1125x2436` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/iphone_1242x2208` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/iphone_640x1136` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/iphone_640x960` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/iphone_750x1334` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/camera_usage_description` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/camera_usage_description_localized` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/microphone_usage_description` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/microphone_usage_description_localized` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/photolibrary_usage_description` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/photolibrary_usage_description_localized` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`storyboard/custom_bg_color` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`storyboard/custom_image@2x` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`storyboard/custom_image@3x` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`storyboard/image_scale_mode` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`storyboard/use_custom_bg_color` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`storyboard/use_launch_screen_storyboard` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`user_data/accessible_from_files_app` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`user_data/accessible_from_itunes_sharing` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_EditorExportPlatformIOS_property_application/app_store_team_id: + +.. rst-class:: classref-property + +:ref:`String` **application/app_store_team_id** + +Apple Team ID, unique 10-character string. To locate your Team ID check "Membership details" section in your Apple developer account dashboard, or "Organizational Unit" of your code signing certificate. See `Locate your Team ID `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_application/bundle_identifier: + +.. rst-class:: classref-property + +:ref:`String` **application/bundle_identifier** + +Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters (``A-Z``, ``a-z``, and ``0-9``), hyphens (``-``), and periods (``.``). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_application/code_sign_identity_debug: + +.. rst-class:: classref-property + +:ref:`String` **application/code_sign_identity_debug** + +The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for debug export. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_application/code_sign_identity_release: + +.. rst-class:: classref-property + +:ref:`String` **application/code_sign_identity_release** + +The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for release export. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_application/export_method_debug: + +.. rst-class:: classref-property + +:ref:`int` **application/export_method_debug** + +Application distribution target (debug export). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_application/export_method_release: + +.. rst-class:: classref-property + +:ref:`int` **application/export_method_release** + +Application distribution target (release export). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_application/icon_interpolation: + +.. rst-class:: classref-property + +:ref:`int` **application/icon_interpolation** + +Interpolation method used to resize application icon. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_application/launch_screens_interpolation: + +.. rst-class:: classref-property + +:ref:`int` **application/launch_screens_interpolation** + +Interpolation method used to resize launch screen images. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_application/provisioning_profile_uuid_debug: + +.. rst-class:: classref-property + +:ref:`String` **application/provisioning_profile_uuid_debug** + +UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See `Edit, download, or delete provisioning profiles `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_application/provisioning_profile_uuid_release: + +.. rst-class:: classref-property + +:ref:`String` **application/provisioning_profile_uuid_release** + +UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See `Edit, download, or delete provisioning profiles `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_application/short_version: + +.. rst-class:: classref-property + +:ref:`String` **application/short_version** + +Application version visible to the user, can only contain numeric characters (``0-9``) and periods (``.``). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_application/signature: + +.. rst-class:: classref-property + +:ref:`String` **application/signature** + +A four-character creator code that is specific to the bundle. Optional. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_application/targeted_device_family: + +.. rst-class:: classref-property + +:ref:`int` **application/targeted_device_family** + +Supported device family. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_application/version: + +.. rst-class:: classref-property + +:ref:`String` **application/version** + +Machine-readable application version, in the ``major.minor.patch`` format, can only contain numeric characters (``0-9``) and periods (``.``). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_architectures/arm64: + +.. rst-class:: classref-property + +:ref:`bool` **architectures/arm64** + +If ``true``, ``arm64`` binaries are included into exported project. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_capabilities/access_wifi: + +.. rst-class:: classref-property + +:ref:`bool` **capabilities/access_wifi** + +If ``true``, networking features related to Wi-Fi access are enabled. See `Required Device Capabilities `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_capabilities/push_notifications: + +.. rst-class:: classref-property + +:ref:`bool` **capabilities/push_notifications** + +If ``true``, push notifications are enabled. See `Required Device Capabilities `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_custom_template/debug: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/debug** + +Path to the custom export template. If left empty, default template is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_custom_template/release: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/release** + +Path to the custom export template. If left empty, default template is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/app_store_1024x1024: + +.. rst-class:: classref-property + +:ref:`String` **icons/app_store_1024x1024** + +App Store application icon file. If left empty, project icon is used instead. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ipad_152x152: + +.. rst-class:: classref-property + +:ref:`String` **icons/ipad_152x152** + +Home screen application icon file on iPad (2x DPI). If left empty, project icon is used instead. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ipad_167x167: + +.. rst-class:: classref-property + +:ref:`String` **icons/ipad_167x167** + +Home screen application icon file on iPad (3x DPI). If left empty, project icon is used instead. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/ipad_76x76: + +.. rst-class:: classref-property + +:ref:`String` **icons/ipad_76x76** + +Home screen application icon file on iPad (1x DPI). If left empty, project icon is used instead. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/iphone_120x120: + +.. rst-class:: classref-property + +:ref:`String` **icons/iphone_120x120** + +Home screen application icon file on iPhone (2x DPI). If left empty, project icon is used instead. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/iphone_180x180: + +.. rst-class:: classref-property + +:ref:`String` **icons/iphone_180x180** + +Home screen application icon file on iPhone (3x DPI). If left empty, project icon is used instead. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/notification_40x40: + +.. rst-class:: classref-property + +:ref:`String` **icons/notification_40x40** + +Notification icon file on iPad and iPhone (2x DPI). If left empty, project icon is used instead. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/notification_60x60: + +.. rst-class:: classref-property + +:ref:`String` **icons/notification_60x60** + +Notification icon file on iPhone (3x DPI). If left empty, project icon is used instead. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/settings_58x58: + +.. rst-class:: classref-property + +:ref:`String` **icons/settings_58x58** + +Application settings icon file on iPad and iPhone (2x DPI). If left empty, project icon is used instead. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/settings_87x87: + +.. rst-class:: classref-property + +:ref:`String` **icons/settings_87x87** + +Application settings icon file on iPhone (3x DPI). If left empty, project icon is used instead. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/spotlight_40x40: + +.. rst-class:: classref-property + +:ref:`String` **icons/spotlight_40x40** + +Spotlight icon file on iPad (1x DPI). If left empty, project icon is used instead. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_icons/spotlight_80x80: + +.. rst-class:: classref-property + +:ref:`String` **icons/spotlight_80x80** + +Spotlight icon file on iPad and iPhone (2x DPI). If left empty, project icon is used instead. See `App icons `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_landscape_launch_screens/ipad_1024x768: + +.. rst-class:: classref-property + +:ref:`String` **landscape_launch_screens/ipad_1024x768** + +Application launch screen image file, if left empty project splash screen is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_landscape_launch_screens/ipad_2048x1536: + +.. rst-class:: classref-property + +:ref:`String` **landscape_launch_screens/ipad_2048x1536** + +Application launch screen image file, if left empty project splash screen is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_landscape_launch_screens/iphone_2208x1242: + +.. rst-class:: classref-property + +:ref:`String` **landscape_launch_screens/iphone_2208x1242** + +Application launch screen image file, if left empty project splash screen is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_landscape_launch_screens/iphone_2436x1125: + +.. rst-class:: classref-property + +:ref:`String` **landscape_launch_screens/iphone_2436x1125** + +Application launch screen image file, if left empty project splash screen is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/ipad_1536x2048: + +.. rst-class:: classref-property + +:ref:`String` **portrait_launch_screens/ipad_1536x2048** + +Application launch screen image file, if left empty project splash screen is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/ipad_768x1024: + +.. rst-class:: classref-property + +:ref:`String` **portrait_launch_screens/ipad_768x1024** + +Application launch screen image file, if left empty project splash screen is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_1125x2436: + +.. rst-class:: classref-property + +:ref:`String` **portrait_launch_screens/iphone_1125x2436** + +Application launch screen image file, if left empty project splash screen is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_1242x2208: + +.. rst-class:: classref-property + +:ref:`String` **portrait_launch_screens/iphone_1242x2208** + +Application launch screen image file, if left empty project splash screen is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_640x1136: + +.. rst-class:: classref-property + +:ref:`String` **portrait_launch_screens/iphone_640x1136** + +Application launch screen image file, if left empty project splash screen is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_640x960: + +.. rst-class:: classref-property + +:ref:`String` **portrait_launch_screens/iphone_640x960** + +Application launch screen image file, if left empty project splash screen is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_portrait_launch_screens/iphone_750x1334: + +.. rst-class:: classref-property + +:ref:`String` **portrait_launch_screens/iphone_750x1334** + +Application launch screen image file, if left empty project splash screen is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/camera_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/camera_usage_description** + +A message displayed when requesting access to the device's camera (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/camera_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/camera_usage_description_localized** + +A message displayed when requesting access to the device's camera (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/microphone_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/microphone_usage_description** + +A message displayed when requesting access to the device's microphone (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/microphone_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/microphone_usage_description_localized** + +A message displayed when requesting access to the device's microphone (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/photolibrary_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/photolibrary_usage_description** + +A message displayed when requesting access to the user's photo library (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/photolibrary_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/photolibrary_usage_description_localized** + +A message displayed when requesting access to the user's photo library (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_storyboard/custom_bg_color: + +.. rst-class:: classref-property + +:ref:`Color` **storyboard/custom_bg_color** + +A custom background color of the storyboard launch screen. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_storyboard/custom_image@2x: + +.. rst-class:: classref-property + +:ref:`String` **storyboard/custom_image@2x** + +Application launch screen image file (2x DPI), if left empty project splash screen is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_storyboard/custom_image@3x: + +.. rst-class:: classref-property + +:ref:`String` **storyboard/custom_image@3x** + +Application launch screen image file (3x DPI), if left empty project splash screen is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_storyboard/image_scale_mode: + +.. rst-class:: classref-property + +:ref:`int` **storyboard/image_scale_mode** + +Launch screen image scaling mode. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_storyboard/use_custom_bg_color: + +.. rst-class:: classref-property + +:ref:`bool` **storyboard/use_custom_bg_color** + +If ``true``, :ref:`storyboard/custom_bg_color` is used as a launch screen background color, otherwise ``application/boot_splash/bg_color`` project setting is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_storyboard/use_launch_screen_storyboard: + +.. rst-class:: classref-property + +:ref:`bool` **storyboard/use_launch_screen_storyboard** + +If ``true``, storyboard launch screen is used instead of launch screen images. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_user_data/accessible_from_files_app: + +.. rst-class:: classref-property + +:ref:`bool` **user_data/accessible_from_files_app** + +If ``true``, the app "Documents" folder can be accessed via "Files" app. See `LSSupportsOpeningDocumentsInPlace `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_user_data/accessible_from_itunes_sharing: + +.. rst-class:: classref-property + +:ref:`bool` **user_data/accessible_from_itunes_sharing** + +If ``true``, the app "Documents" folder can be accessed via iTunes file sharing. See `UIFileSharingEnabled `__. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_editorexportplatformlinuxbsd.rst b/classes/class_editorexportplatformlinuxbsd.rst new file mode 100644 index 00000000000..e83d1c26ac7 --- /dev/null +++ b/classes/class_editorexportplatformlinuxbsd.rst @@ -0,0 +1,292 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/platform/linuxbsd/doc_classes/EditorExportPlatformLinuxBSD.xml. + +.. _class_EditorExportPlatformLinuxBSD: + +EditorExportPlatformLinuxBSD +============================ + +**Inherits:** :ref:`EditorExportPlatformPC` **<** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` + +Exporter for Linux/BSD. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Exporting for Linux <../tutorials/export/exporting_for_linux>` + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`binary_format/architecture` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`binary_format/embed_pck` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/debug` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/release` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debug/export_console_script` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/cleanup_script` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`ssh_remote_deploy/enabled` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/extra_args_scp` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/extra_args_ssh` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/host` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/port` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/run_script` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`texture_format/bptc` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`texture_format/etc` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`texture_format/etc2` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`texture_format/s3tc` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_EditorExportPlatformLinuxBSD_property_binary_format/architecture: + +.. rst-class:: classref-property + +:ref:`String` **binary_format/architecture** + +Application executable architecture. + +Supported architectures: ``x86_32``, ``x86_64``, ``arm64``, ``arm32``, ``rv64``, ``ppc64``, and ``ppc32``. + +Official export templates include ``x86_32`` and ``x86_64`` binaries only. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_binary_format/embed_pck: + +.. rst-class:: classref-property + +:ref:`bool` **binary_format/embed_pck** + +If ``true``, project resources are embedded into the executable. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_custom_template/debug: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/debug** + +Path to the custom export template. If left empty, default template is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_custom_template/release: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/release** + +Path to the custom export template. If left empty, default template is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_debug/export_console_script: + +.. rst-class:: classref-property + +:ref:`int` **debug/export_console_script** + +If ``true``, a console wrapper script is exported alongside the main executable, which allows running the project with enabled console output. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/cleanup_script: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/cleanup_script** + +Script code to execute on the remote host when app is finished. + +The following variables can be used in the script: + +- ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to. + +- ``{archive_name}`` - Name of the ZIP containing uploaded application. + +- ``{exe_name}`` - Name of application executable. + +- ``{cmd_args}`` - Array of the command line argument for the application. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/enabled: + +.. rst-class:: classref-property + +:ref:`bool` **ssh_remote_deploy/enabled** + +Enables remote deploy using SSH/SCP. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/extra_args_scp: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/extra_args_scp** + +Array of the additional command line arguments passed to the SCP. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/extra_args_ssh: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/extra_args_ssh** + +Array of the additional command line arguments passed to the SSH. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/host: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/host** + +Remote host SSH user name and address, in ``user@address`` format. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/port: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/port** + +Remote host SSH port number. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_ssh_remote_deploy/run_script: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/run_script** + +Script code to execute on the remote host when running the app. + +The following variables can be used in the script: + +- ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to. + +- ``{archive_name}`` - Name of the ZIP containing uploaded application. + +- ``{exe_name}`` - Name of application executable. + +- ``{cmd_args}`` - Array of the command line argument for the application. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_texture_format/bptc: + +.. rst-class:: classref-property + +:ref:`bool` **texture_format/bptc** + +If ``true``, project textures are exported in the BPTC format. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_texture_format/etc: + +.. rst-class:: classref-property + +:ref:`bool` **texture_format/etc** + +If ``true``, project textures are exported in the ETC format. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_texture_format/etc2: + +.. rst-class:: classref-property + +:ref:`bool` **texture_format/etc2** + +If ``true``, project textures are exported in the ETC2 format. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformLinuxBSD_property_texture_format/s3tc: + +.. rst-class:: classref-property + +:ref:`bool` **texture_format/s3tc** + +If ``true``, project textures are exported in the S3TC format. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_editorexportplatformmacos.rst b/classes/class_editorexportplatformmacos.rst new file mode 100644 index 00000000000..e61eab90f0a --- /dev/null +++ b/classes/class_editorexportplatformmacos.rst @@ -0,0 +1,1304 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/platform/macos/doc_classes/EditorExportPlatformMacOS.xml. + +.. _class_EditorExportPlatformMacOS: + +EditorExportPlatformMacOS +========================= + +**Inherits:** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` + +Exporter for macOS. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Exporting for macOS <../tutorials/export/exporting_for_macos>` + +- :doc:`Running Godot apps on macOS <../tutorials//export/running_on_macos>` + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/app_category` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/bundle_identifier` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/copyright` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`application/copyright_localized` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/icon` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/icon_interpolation` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/min_macos_version` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/short_version` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/signature` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/version` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`binary_format/architecture` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`codesign/apple_team_id` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`codesign/certificate_file` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`codesign/certificate_password` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`codesign/codesign` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`codesign/custom_options` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/address_book` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/allow_dyld_environment_variables` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/allow_jit_code_execution` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/allow_unsigned_executable_memory` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/app_sandbox/device_bluetooth` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/app_sandbox/device_usb` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/app_sandbox/enabled` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`codesign/entitlements/app_sandbox/files_downloads` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`codesign/entitlements/app_sandbox/files_movies` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`codesign/entitlements/app_sandbox/files_music` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`codesign/entitlements/app_sandbox/files_pictures` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`codesign/entitlements/app_sandbox/helper_executables` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/app_sandbox/network_client` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/app_sandbox/network_server` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/apple_events` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/audio_input` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/calendars` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/camera` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`codesign/entitlements/custom_file` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/debugging` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/disable_library_validation` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/location` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/entitlements/photos_library` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`codesign/identity` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`codesign/installer_identity` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`codesign/provisioning_profile` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/debug` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/release` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debug/export_console_script` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/high_res` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`export/distribution_type` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`notarization/api_key` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`notarization/api_key_id` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`notarization/api_uuid` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`notarization/apple_id_name` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`notarization/apple_id_password` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`notarization/notarization` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/address_book_usage_description` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/address_book_usage_description_localized` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/calendar_usage_description` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/calendar_usage_description_localized` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/camera_usage_description` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/camera_usage_description_localized` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/desktop_folder_usage_description` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/desktop_folder_usage_description_localized` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/documents_folder_usage_description` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/documents_folder_usage_description_localized` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/downloads_folder_usage_description` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/downloads_folder_usage_description_localized` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/location_usage_description` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/location_usage_description_localized` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/microphone_usage_description` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/microphone_usage_description_localized` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/network_volumes_usage_description` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/network_volumes_usage_description_localized` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/photos_library_usage_description` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/photos_library_usage_description_localized` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/removable_volumes_usage_description` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/removable_volumes_usage_description_localized` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/cleanup_script` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`ssh_remote_deploy/enabled` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/extra_args_scp` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/extra_args_ssh` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/host` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/port` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/run_script` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`xcode/platform_build` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`xcode/sdk_build` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`xcode/sdk_name` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`xcode/sdk_version` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`xcode/xcode_build` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`xcode/xcode_version` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_EditorExportPlatformMacOS_property_application/app_category: + +.. rst-class:: classref-property + +:ref:`String` **application/app_category** + +Application category for the App Store. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_application/bundle_identifier: + +.. rst-class:: classref-property + +:ref:`String` **application/bundle_identifier** + +Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters (``A-Z``, ``a-z``, and ``0-9``), hyphens (``-``), and periods (``.``). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_application/copyright: + +.. rst-class:: classref-property + +:ref:`String` **application/copyright** + +Copyright notice for the bundle visible to the user (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_application/copyright_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **application/copyright_localized** + +Copyright notice for the bundle visible to the user (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_application/icon: + +.. rst-class:: classref-property + +:ref:`String` **application/icon** + +Application icon file. If left empty, project icon is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_application/icon_interpolation: + +.. rst-class:: classref-property + +:ref:`int` **application/icon_interpolation** + +Interpolation method used to resize application icon. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_application/min_macos_version: + +.. rst-class:: classref-property + +:ref:`String` **application/min_macos_version** + +Minimum version of macOS required for this application to run in the ``major.minor.patch`` or ``major.minor`` format, can only contain numeric characters (``0-9``) and periods (``.``). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_application/short_version: + +.. rst-class:: classref-property + +:ref:`String` **application/short_version** + +Application version visible to the user, can only contain numeric characters (``0-9``) and periods (``.``). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_application/signature: + +.. rst-class:: classref-property + +:ref:`String` **application/signature** + +A four-character creator code that is specific to the bundle. Optional. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_application/version: + +.. rst-class:: classref-property + +:ref:`String` **application/version** + +Machine-readable application version, in the ``major.minor.patch`` format, can only contain numeric characters (``0-9``) and periods (``.``). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_binary_format/architecture: + +.. rst-class:: classref-property + +:ref:`String` **binary_format/architecture** + +Application executable architecture. + +Supported architectures: ``x86_64``, ``arm64``, and ``universal`` (``x86_64 + arm64``). + +Official export templates include ``universal`` binaries only. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/apple_team_id: + +.. rst-class:: classref-property + +:ref:`String` **codesign/apple_team_id** + +Apple Team ID, unique 10-character string. To locate your Team ID check "Membership details" section in your Apple developer account dashboard, or "Organizational Unit" of your code signing certificate. See `Locate your Team ID `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/certificate_file: + +.. rst-class:: classref-property + +:ref:`String` **codesign/certificate_file** + +PKCS #12 certificate file used to sign ``.app`` bundle. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/certificate_password: + +.. rst-class:: classref-property + +:ref:`String` **codesign/certificate_password** + +Password for the certificate file used to sign ``.app`` bundle. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/codesign: + +.. rst-class:: classref-property + +:ref:`int` **codesign/codesign** + +Tool to use for code signing. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/custom_options: + +.. rst-class:: classref-property + +:ref:`PackedStringArray` **codesign/custom_options** + +Array of the additional command line arguments passed to the code signing tool. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/address_book: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/address_book** + +Enable to allow access to contacts in the user's address book, if it's enabled you should also provide usage message in the ``privacy/address_book_usage_description`` option. See `com.apple.security.personal-information.addressbook `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/allow_dyld_environment_variables: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/allow_dyld_environment_variables** + +Allows app to use dynamic linker environment variables to inject code. If you are using add-ons with dynamic or self-modifying native code, enable them according to the add-on documentation. See `com.apple.security.cs.allow-dyld-environment-variables `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/allow_jit_code_execution: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/allow_jit_code_execution** + +Allows creating writable and executable memory for JIT code. If you are using add-ons with dynamic or self-modifying native code, enable them according to the add-on documentation. See `com.apple.security.cs.allow-jit `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/allow_unsigned_executable_memory: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/allow_unsigned_executable_memory** + +Allows creating writable and executable memory without JIT restrictions. If you are using add-ons with dynamic or self-modifying native code, enable them according to the add-on documentation. See `com.apple.security.cs.allow-unsigned-executable-memory `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/device_bluetooth: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/app_sandbox/device_bluetooth** + +Enable to allow app to interact with Bluetooth devices. This entitlement is required to use wireless controllers. See `com.apple.security.device.bluetooth `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/device_usb: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/app_sandbox/device_usb** + +Enable to allow app to interact with USB devices. This entitlement is required to use wired controllers. See `com.apple.security.device.usb `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/enabled: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/app_sandbox/enabled** + +Enables App Sandbox. The App Sandbox restricts access to user data, networking, and devices. Sandboxed apps can't access most of the file system, can't use custom file dialogs and execute binaries outside the .app bundle. See `App Sandbox `__. + +\ **Note:** To distribute an app through the App Store, you must enable the App Sandbox. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_downloads: + +.. rst-class:: classref-property + +:ref:`int` **codesign/entitlements/app_sandbox/files_downloads** + +Allows read or write access to the user's "Downloads" folder. See `com.apple.security.files.downloads.read-write `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_movies: + +.. rst-class:: classref-property + +:ref:`int` **codesign/entitlements/app_sandbox/files_movies** + +Allows read or write access to the user's "Movies" folder. See `com.apple.security.files.movies.read-write `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_music: + +.. rst-class:: classref-property + +:ref:`int` **codesign/entitlements/app_sandbox/files_music** + +Allows read or write access to the user's "Music" folder. See `com.apple.security.files.music.read-write `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_pictures: + +.. rst-class:: classref-property + +:ref:`int` **codesign/entitlements/app_sandbox/files_pictures** + +Allows read or write access to the user's "Pictures" folder. See `com.apple.security.files.pictures.read-write `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/helper_executables: + +.. rst-class:: classref-property + +:ref:`Array` **codesign/entitlements/app_sandbox/helper_executables** + +List of helper executables to embedded to the app bundle. Sandboxed app are limited to execute only these executable. See `Embedding a command-line tool in a sandboxed app `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/network_client: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/app_sandbox/network_client** + +Enable to allow app to establish outgoing network connections. See `com.apple.security.network.client `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/network_server: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/app_sandbox/network_server** + +Enable to allow app to listen for incoming network connections. See `com.apple.security.network.server `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/apple_events: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/apple_events** + +Enable to allow app to send Apple events to other apps. See `com.apple.security.automation.apple-events `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/audio_input: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/audio_input** + +Enable if you need to use the microphone or other audio input sources, if it's enabled you should also provide usage message in the ``privacy/microphone_usage_description`` option. See `com.apple.security.device.audio-input `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/calendars: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/calendars** + +Enable to allow access to the user's calendar, if it's enabled you should also provide usage message in the ``privacy/calendar_usage_description`` option. See `com.apple.security.personal-information.calendars `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/camera: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/camera** + +Enable if you need to use the camera, if it's enabled you should also provide usage message in the ``privacy/camera_usage_description`` option. See `com.apple.security.device.camera `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/custom_file: + +.. rst-class:: classref-property + +:ref:`String` **codesign/entitlements/custom_file** + +Custom entitlements ``.plist`` file, if specified the rest of entitlements in the export config are ignored. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/debugging: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/debugging** + +You can temporarily enable this entitlement to use native debugger (GDB, LLDB) with the exported app. This entitlement should be disabled for production export. See `Embedding a command-line tool in a sandboxed app `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/disable_library_validation: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/disable_library_validation** + +Allows app to load arbitrary libraries and frameworks (not signed with the same Team ID as the main executable or by Apple). Enable it if you are using GDExtension add-ons or ad-hoc signing, or want to support user-provided external add-ons. See `com.apple.security.cs.disable-library-validation `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/location: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/location** + +Enable if you need to use location information from Location Services, if it's enabled you should also provide usage message in the ``privacy/location_usage_description`` option. See `com.apple.security.personal-information.location `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/photos_library: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/entitlements/photos_library** + +Enable to allow access to the user's Photos library, if it's enabled you should also provide usage message in the ``privacy/photos_library_usage_description`` option. See `com.apple.security.personal-information.photos-library `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/identity: + +.. rst-class:: classref-property + +:ref:`String` **codesign/identity** + +The "Full Name", "Common Name" or SHA-1 hash of the signing identity used to sign ``.app`` bundle. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/installer_identity: + +.. rst-class:: classref-property + +:ref:`String` **codesign/installer_identity** + +The "Full Name", "Common Name" or SHA-1 hash of the signing identity used to sign ``.pkg`` installer package for App Store distribution, use ``3rd Party Mac Developer Installer: Name.`` identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_codesign/provisioning_profile: + +.. rst-class:: classref-property + +:ref:`String` **codesign/provisioning_profile** + +Provisioning profile file downloaded from Apple developer account dashboard. See `Edit, download, or delete provisioning profiles `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_custom_template/debug: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/debug** + +Path to the custom export template. If left empty, default template is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_custom_template/release: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/release** + +Path to the custom export template. If left empty, default template is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_debug/export_console_script: + +.. rst-class:: classref-property + +:ref:`int` **debug/export_console_script** + +If enabled, a script file that can be used to run the application with console output is created alongside the exported application. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_display/high_res: + +.. rst-class:: classref-property + +:ref:`bool` **display/high_res** + +If ``true``, the application is rendered at native display resolution, otherwise it is always rendered at loHPI resolution and upscaled by OS when required. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_export/distribution_type: + +.. rst-class:: classref-property + +:ref:`int` **export/distribution_type** + +Application distribution target. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_notarization/api_key: + +.. rst-class:: classref-property + +:ref:`String` **notarization/api_key** + +Apple App Store Connect API issuer key file. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_notarization/api_key_id: + +.. rst-class:: classref-property + +:ref:`String` **notarization/api_key_id** + +Apple App Store Connect API issuer key ID. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_notarization/api_uuid: + +.. rst-class:: classref-property + +:ref:`String` **notarization/api_uuid** + +Apple App Store Connect API issuer UUID. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_notarization/apple_id_name: + +.. rst-class:: classref-property + +:ref:`String` **notarization/apple_id_name** + +Apple ID account name (email address). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_notarization/apple_id_password: + +.. rst-class:: classref-property + +:ref:`String` **notarization/apple_id_password** + +Apple ID app-specific password. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_notarization/notarization: + +.. rst-class:: classref-property + +:ref:`int` **notarization/notarization** + +Tool to use for notarization. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/address_book_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/address_book_usage_description** + +A message displayed when requesting access to the user's contacts (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/address_book_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/address_book_usage_description_localized** + +A message displayed when requesting access to the user's contacts (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/calendar_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/calendar_usage_description** + +A message displayed when requesting access to the user's calendar data (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/calendar_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/calendar_usage_description_localized** + +A message displayed when requesting access to the user's calendar data (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/camera_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/camera_usage_description** + +A message displayed when requesting access to the device's camera (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/camera_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/camera_usage_description_localized** + +A message displayed when requesting access to the device's camera (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/desktop_folder_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/desktop_folder_usage_description** + +A message displayed when requesting access to the user's "Desktop" folder (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/desktop_folder_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/desktop_folder_usage_description_localized** + +A message displayed when requesting access to the user's "Desktop" folder (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/documents_folder_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/documents_folder_usage_description** + +A message displayed when requesting access to the user's "Documents" folder (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/documents_folder_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/documents_folder_usage_description_localized** + +A message displayed when requesting access to the user's "Documents" folder (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/downloads_folder_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/downloads_folder_usage_description** + +A message displayed when requesting access to the user's "Downloads" folder (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/downloads_folder_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/downloads_folder_usage_description_localized** + +A message displayed when requesting access to the user's "Downloads" folder (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/location_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/location_usage_description** + +A message displayed when requesting access to the user's location information (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/location_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/location_usage_description_localized** + +A message displayed when requesting access to the user's location information (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/microphone_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/microphone_usage_description** + +A message displayed when requesting access to the device's microphone (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/microphone_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/microphone_usage_description_localized** + +A message displayed when requesting access to the device's microphone (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/network_volumes_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/network_volumes_usage_description** + +A message displayed when requesting access to the user's network drives (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/network_volumes_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/network_volumes_usage_description_localized** + +A message displayed when requesting access to the user's network drives (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/photos_library_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/photos_library_usage_description** + +A message displayed when requesting access to the user's photo library (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/photos_library_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/photos_library_usage_description_localized** + +A message displayed when requesting access to the user's photo library (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/removable_volumes_usage_description: + +.. rst-class:: classref-property + +:ref:`String` **privacy/removable_volumes_usage_description** + +A message displayed when requesting access to the user's removable drives (in English). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_privacy/removable_volumes_usage_description_localized: + +.. rst-class:: classref-property + +:ref:`Dictionary` **privacy/removable_volumes_usage_description_localized** + +A message displayed when requesting access to the user's removable drives (localized). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/cleanup_script: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/cleanup_script** + +Script code to execute on the remote host when app is finished. + +The following variables can be used in the script: + +- ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to. + +- ``{archive_name}`` - Name of the ZIP containing uploaded application. + +- ``{exe_name}`` - Name of application executable. + +- ``{cmd_args}`` - Array of the command line argument for the application. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/enabled: + +.. rst-class:: classref-property + +:ref:`bool` **ssh_remote_deploy/enabled** + +Enables remote deploy using SSH/SCP. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/extra_args_scp: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/extra_args_scp** + +Array of the additional command line arguments passed to the SCP. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/extra_args_ssh: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/extra_args_ssh** + +Array of the additional command line arguments passed to the SSH. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/host: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/host** + +Remote host SSH user name and address, in ``user@address`` format. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/port: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/port** + +Remote host SSH port number. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_ssh_remote_deploy/run_script: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/run_script** + +Script code to execute on the remote host when running the app. + +The following variables can be used in the script: + +- ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to. + +- ``{archive_name}`` - Name of the ZIP containing uploaded application. + +- ``{exe_name}`` - Name of application executable. + +- ``{cmd_args}`` - Array of the command line argument for the application. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_xcode/platform_build: + +.. rst-class:: classref-property + +:ref:`String` **xcode/platform_build** + +macOS build number used to build application executable. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_xcode/sdk_build: + +.. rst-class:: classref-property + +:ref:`String` **xcode/sdk_build** + +macOS SDK build number used to build application executable. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_xcode/sdk_name: + +.. rst-class:: classref-property + +:ref:`String` **xcode/sdk_name** + +macOS SDK name used to build application executable. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_xcode/sdk_version: + +.. rst-class:: classref-property + +:ref:`String` **xcode/sdk_version** + +macOS SDK version used to build application executable in the ``major.minor`` format. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_xcode/xcode_build: + +.. rst-class:: classref-property + +:ref:`String` **xcode/xcode_build** + +Xcode build number used to build application executable. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformMacOS_property_xcode/xcode_version: + +.. rst-class:: classref-property + +:ref:`String` **xcode/xcode_version** + +Xcode version used to build application executable. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_animationtrackeditplugin.rst b/classes/class_editorexportplatformpc.rst similarity index 66% rename from classes/class_animationtrackeditplugin.rst rename to classes/class_editorexportplatformpc.rst index 591ceec66e3..1e5bbfb0ec0 100644 --- a/classes/class_animationtrackeditplugin.rst +++ b/classes/class_editorexportplatformpc.rst @@ -3,18 +3,18 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationTrackEditPlugin.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPlatformPC.xml. -.. _class_AnimationTrackEditPlugin: +.. _class_EditorExportPlatformPC: -AnimationTrackEditPlugin -======================== +EditorExportPlatformPC +====================== -**Inherits:** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` -.. container:: contribute +**Inherited By:** :ref:`EditorExportPlatformLinuxBSD`, :ref:`EditorExportPlatformWindows` - There is currently no description for this class. Please help us by :ref:`contributing one `! +Base class for the desktop platform exporter (Windows and Linux/BSD). .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_editorexportplatformweb.rst b/classes/class_editorexportplatformweb.rst new file mode 100644 index 00000000000..a9833091c66 --- /dev/null +++ b/classes/class_editorexportplatformweb.rst @@ -0,0 +1,342 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/platform/web/doc_classes/EditorExportPlatformWeb.xml. + +.. _class_EditorExportPlatformWeb: + +EditorExportPlatformWeb +======================= + +**Inherits:** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` + +Exporter for the Web. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Exporting for the Web <../tutorials/export/exporting_for_web>` + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/debug` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/release` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`html/canvas_resize_policy` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`html/custom_html_shell` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`html/experimental_virtual_keyboard` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`html/export_icon` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`html/focus_canvas_on_start` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`html/head_include` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`progressive_web_app/background_color` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`progressive_web_app/display` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`progressive_web_app/enabled` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`progressive_web_app/icon_144x144` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`progressive_web_app/icon_180x180` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`progressive_web_app/icon_512x512` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`progressive_web_app/offline_page` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`progressive_web_app/orientation` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`variant/extensions_support` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`vram_texture_compression/for_desktop` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`vram_texture_compression/for_mobile` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_EditorExportPlatformWeb_property_custom_template/debug: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/debug** + +Path to the custom export template. If left empty, default template is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_custom_template/release: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/release** + +Path to the custom export template. If left empty, default template is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_html/canvas_resize_policy: + +.. rst-class:: classref-property + +:ref:`int` **html/canvas_resize_policy** + +The canvas resize policy determines how the canvas should be resized by Godot. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_html/custom_html_shell: + +.. rst-class:: classref-property + +:ref:`String` **html/custom_html_shell** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_html/experimental_virtual_keyboard: + +.. rst-class:: classref-property + +:ref:`bool` **html/experimental_virtual_keyboard** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_html/export_icon: + +.. rst-class:: classref-property + +:ref:`bool` **html/export_icon** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_html/focus_canvas_on_start: + +.. rst-class:: classref-property + +:ref:`bool` **html/focus_canvas_on_start** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_html/head_include: + +.. rst-class:: classref-property + +:ref:`String` **html/head_include** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_progressive_web_app/background_color: + +.. rst-class:: classref-property + +:ref:`Color` **progressive_web_app/background_color** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_progressive_web_app/display: + +.. rst-class:: classref-property + +:ref:`int` **progressive_web_app/display** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_progressive_web_app/enabled: + +.. rst-class:: classref-property + +:ref:`bool` **progressive_web_app/enabled** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_progressive_web_app/icon_144x144: + +.. rst-class:: classref-property + +:ref:`String` **progressive_web_app/icon_144x144** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_progressive_web_app/icon_180x180: + +.. rst-class:: classref-property + +:ref:`String` **progressive_web_app/icon_180x180** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_progressive_web_app/icon_512x512: + +.. rst-class:: classref-property + +:ref:`String` **progressive_web_app/icon_512x512** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_progressive_web_app/offline_page: + +.. rst-class:: classref-property + +:ref:`String` **progressive_web_app/offline_page** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_progressive_web_app/orientation: + +.. rst-class:: classref-property + +:ref:`int` **progressive_web_app/orientation** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_variant/extensions_support: + +.. rst-class:: classref-property + +:ref:`bool` **variant/extensions_support** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_vram_texture_compression/for_desktop: + +.. rst-class:: classref-property + +:ref:`bool` **vram_texture_compression/for_desktop** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWeb_property_vram_texture_compression/for_mobile: + +.. rst-class:: classref-property + +:ref:`bool` **vram_texture_compression/for_mobile** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_editorexportplatformwindows.rst b/classes/class_editorexportplatformwindows.rst new file mode 100644 index 00000000000..60fff8d5bce --- /dev/null +++ b/classes/class_editorexportplatformwindows.rst @@ -0,0 +1,572 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/platform/windows/doc_classes/EditorExportPlatformWindows.xml. + +.. _class_EditorExportPlatformWindows: + +EditorExportPlatformWindows +=========================== + +**Inherits:** :ref:`EditorExportPlatformPC` **<** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` + +Exporter for Windows. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Exporting for Windows <../tutorials/export/exporting_for_windows>` + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/company_name` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/console_wrapper_icon` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/copyright` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/file_description` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/file_version` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/icon` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/icon_interpolation` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/modify_resources` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/product_name` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/product_version` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/trademarks` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`binary_format/architecture` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`binary_format/embed_pck` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`codesign/custom_options` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`codesign/description` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`codesign/digest_algorithm` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/enable` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`codesign/identity` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`codesign/identity_type` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`codesign/password` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`codesign/timestamp` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`codesign/timestamp_server_url` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/debug` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/release` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debug/export_console_script` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/cleanup_script` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`ssh_remote_deploy/enabled` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/extra_args_scp` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/extra_args_ssh` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/host` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/port` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ssh_remote_deploy/run_script` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`texture_format/bptc` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`texture_format/etc` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`texture_format/etc2` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`texture_format/s3tc` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_EditorExportPlatformWindows_property_application/company_name: + +.. rst-class:: classref-property + +:ref:`String` **application/company_name** + +Company that produced the application. Required. See `StringFileInfo `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_application/console_wrapper_icon: + +.. rst-class:: classref-property + +:ref:`String` **application/console_wrapper_icon** + +Console wrapper icon file. If left empty, application icon is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_application/copyright: + +.. rst-class:: classref-property + +:ref:`String` **application/copyright** + +Copyright notice for the bundle visible to the user. Optional. See `StringFileInfo `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_application/file_description: + +.. rst-class:: classref-property + +:ref:`String` **application/file_description** + +File description to be presented to users. Required. See `StringFileInfo `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_application/file_version: + +.. rst-class:: classref-property + +:ref:`String` **application/file_version** + +Version number of the file. Required. See `StringFileInfo `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_application/icon: + +.. rst-class:: classref-property + +:ref:`String` **application/icon** + +Application icon file. If left empty, project icon is used instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_application/icon_interpolation: + +.. rst-class:: classref-property + +:ref:`int` **application/icon_interpolation** + +Interpolation method used to resize application icon. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_application/modify_resources: + +.. rst-class:: classref-property + +:ref:`bool` **application/modify_resources** + +If enabled, icon and metadata of the exported executable is set according to the other ``application/*`` values. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_application/product_name: + +.. rst-class:: classref-property + +:ref:`String` **application/product_name** + +Name of the application. Required. See `StringFileInfo `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_application/product_version: + +.. rst-class:: classref-property + +:ref:`String` **application/product_version** + +Application version visible to the user. Required. See `StringFileInfo `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_application/trademarks: + +.. rst-class:: classref-property + +:ref:`String` **application/trademarks** + +Trademarks and registered trademarks that apply to the file. Optional. See `StringFileInfo `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_binary_format/architecture: + +.. rst-class:: classref-property + +:ref:`String` **binary_format/architecture** + +Application executable architecture. + +Supported architectures: ``x86_32``, ``x86_64``, and ``arm64``. + +Official export templates include ``x86_32`` and ``x86_64`` binaries only. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_binary_format/embed_pck: + +.. rst-class:: classref-property + +:ref:`bool` **binary_format/embed_pck** + +If ``true``, project resources are embedded into the executable. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_codesign/custom_options: + +.. rst-class:: classref-property + +:ref:`PackedStringArray` **codesign/custom_options** + +Array of the additional command line arguments passed to the code signing tool. See `Sign Tool `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_codesign/description: + +.. rst-class:: classref-property + +:ref:`String` **codesign/description** + +Description of the signed content. See `Sign Tool `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_codesign/digest_algorithm: + +.. rst-class:: classref-property + +:ref:`int` **codesign/digest_algorithm** + +Digest algorithm to use for creating signature. See `Sign Tool `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_codesign/enable: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/enable** + +If ``true``, executable signing is enabled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_codesign/identity: + +.. rst-class:: classref-property + +:ref:`String` **codesign/identity** + +PKCS #12 certificate file used to sign executable or certificate SHA-1 hash (if :ref:`codesign/identity_type` is set to "Use certificate store"). See `Sign Tool `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_codesign/identity_type: + +.. rst-class:: classref-property + +:ref:`int` **codesign/identity_type** + +Type of identity to use. See `Sign Tool `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_codesign/password: + +.. rst-class:: classref-property + +:ref:`String` **codesign/password** + +Password for the certificate file used to sign executable. See `Sign Tool `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_codesign/timestamp: + +.. rst-class:: classref-property + +:ref:`bool` **codesign/timestamp** + +If ``true``, time-stamp is added to the signature. See `Sign Tool `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_codesign/timestamp_server_url: + +.. rst-class:: classref-property + +:ref:`String` **codesign/timestamp_server_url** + +URL of the time stamp server. If left empty, the default server is used. See `Sign Tool `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_custom_template/debug: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/debug** + +Path to the custom export template. If left empty, default template is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_custom_template/release: + +.. rst-class:: classref-property + +:ref:`String` **custom_template/release** + +Path to the custom export template. If left empty, default template is used. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_debug/export_console_script: + +.. rst-class:: classref-property + +:ref:`int` **debug/export_console_script** + +If ``true``, a console wrapper executable is exported alongside the main executable, which allows running the project with enabled console output. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/cleanup_script: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/cleanup_script** + +Script code to execute on the remote host when app is finished. + +The following variables can be used in the script: + +- ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to. + +- ``{archive_name}`` - Name of the ZIP containing uploaded application. + +- ``{exe_name}`` - Name of application executable. + +- ``{cmd_args}`` - Array of the command line argument for the application. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/enabled: + +.. rst-class:: classref-property + +:ref:`bool` **ssh_remote_deploy/enabled** + +Enables remote deploy using SSH/SCP. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/extra_args_scp: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/extra_args_scp** + +Array of the additional command line arguments passed to the SCP. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/extra_args_ssh: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/extra_args_ssh** + +Array of the additional command line arguments passed to the SSH. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/host: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/host** + +Remote host SSH user name and address, in ``user@address`` format. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/port: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/port** + +Remote host SSH port number. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/run_script: + +.. rst-class:: classref-property + +:ref:`String` **ssh_remote_deploy/run_script** + +Script code to execute on the remote host when running the app. + +The following variables can be used in the script: + +- ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to. + +- ``{archive_name}`` - Name of the ZIP containing uploaded application. + +- ``{exe_name}`` - Name of application executable. + +- ``{cmd_args}`` - Array of the command line argument for the application. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_texture_format/bptc: + +.. rst-class:: classref-property + +:ref:`bool` **texture_format/bptc** + +If ``true``, project textures are exported in the BPTC format. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_texture_format/etc: + +.. rst-class:: classref-property + +:ref:`bool` **texture_format/etc** + +If ``true``, project textures are exported in the ETC format. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_texture_format/etc2: + +.. rst-class:: classref-property + +:ref:`bool` **texture_format/etc2** + +If ``true``, project textures are exported in the ETC2 format. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformWindows_property_texture_format/s3tc: + +.. rst-class:: classref-property + +:ref:`bool` **texture_format/s3tc** + +If ``true``, project textures are exported in the S3TC format. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 8cdf4241c0e..dee7f58d46f 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -54,8 +54,12 @@ Methods +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_export_features` **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary[]` | :ref:`_get_export_options` **(** :ref:`EditorExportPlatform` platform **)** |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_name` **(** **)** |virtual| |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_should_update_export_options` **(** :ref:`EditorExportPlatform` platform **)** |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_file` **(** :ref:`String` path, :ref:`PackedByteArray` file, :ref:`bool` remap **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_ios_bundle_file` **(** :ref:`String` path **)** | @@ -76,6 +80,8 @@ Methods +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PackedStringArray` tags, :ref:`String` target **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_option` **(** :ref:`StringName` name **)** |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`skip` **(** **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -232,6 +238,26 @@ Return a :ref:`PackedStringArray` of additional feature ---- +.. _class_EditorExportPlugin_method__get_export_options: + +.. rst-class:: classref-method + +:ref:`Dictionary[]` **_get_export_options** **(** :ref:`EditorExportPlatform` platform **)** |virtual| |const| + +Return a list of export options that can be configured for this export plugin. + +Each element in the return value is a :ref:`Dictionary` with the following keys: + +- ``option``: A dictionary with the structure documented by :ref:`Object.get_property_list`, but all keys are optional. + +- ``default_value``: The default value for this option. + +- ``update_visibility``: An optional boolean value. If set to ``true``, the preset will emit :ref:`Object.property_list_changed` when the option is changed. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlugin_method__get_name: .. rst-class:: classref-method @@ -246,6 +272,18 @@ Implementing this method is required. ---- +.. _class_EditorExportPlugin_method__should_update_export_options: + +.. rst-class:: classref-method + +:ref:`bool` **_should_update_export_options** **(** :ref:`EditorExportPlatform` platform **)** |virtual| |const| + +Return ``true``, if the result of :ref:`_get_export_options` has changed and the export options of preset corresponding to ``platform`` should be updated. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlugin_method_add_file: .. rst-class:: classref-method @@ -376,6 +414,18 @@ In case of a directory code-sign will error if you place non code object in dire ---- +.. _class_EditorExportPlugin_method_get_option: + +.. rst-class:: classref-method + +:ref:`Variant` **get_option** **(** :ref:`StringName` name **)** |const| + +Returns the current value of an export option supplied by :ref:`_get_export_options`. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlugin_method_skip: .. rst-class:: classref-method diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index cfbc942f81f..0715ea7dd00 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -351,7 +351,7 @@ The view format in which the **EditorFileDialog** displays resources to the user - void **set_file_mode** **(** :ref:`FileMode` value **)** - :ref:`FileMode` **get_file_mode** **(** **)** -The dialog's open or save mode, which affects the selection behavior. See :ref:`FileMode` +The dialog's open or save mode, which affects the selection behavior. See :ref:`FileMode`. .. rst-class:: classref-item-separator diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 60cef634d96..56ca27e1a9c 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -10,7 +10,7 @@ EditorInterface =============== -**Inherits:** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`Object` Godot editor's interface. @@ -34,6 +34,8 @@ Properties +-------------------------+------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`distraction_free_mode` | +-------------------------+------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`movie_maker_enabled` | + +-------------------------+------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -50,7 +52,7 @@ Methods +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`edit_script` **(** :ref:`Script` script, :ref:`int` line=-1, :ref:`int` column=0, :ref:`bool` grab_focus=true **)** | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`get_base_control` **(** **)** | + | :ref:`Control` | :ref:`get_base_control` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorCommandPalette` | :ref:`get_command_palette` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -58,17 +60,17 @@ Methods +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_current_path` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | + | :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VBoxContainer` | :ref:`get_editor_main_screen` **(** **)** | + | :ref:`VBoxContainer` | :ref:`get_editor_main_screen` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorPaths` | :ref:`get_editor_paths` **(** **)** | + | :ref:`EditorPaths` | :ref:`get_editor_paths` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_editor_scale` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | + | :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FileSystemDock` | :ref:`get_file_system_dock` **(** **)** | + | :ref:`FileSystemDock` | :ref:`get_file_system_dock` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorInspector` | :ref:`get_inspector` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -76,20 +78,18 @@ Methods +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_playing_scene` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | + | :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** | + | :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | + | :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_selected_paths` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | + | :ref:`EditorSelection` | :ref:`get_selection` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`inspect_object` **(** :ref:`Object` object, :ref:`String` for_property="", :ref:`bool` inspector_only=false **)** | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_movie_maker_enabled` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing_scene` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_plugin_enabled` **(** :ref:`String` plugin **)** |const| | @@ -116,8 +116,6 @@ Methods +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_main_screen_editor` **(** :ref:`String` name **)** | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_movie_maker_enabled` **(** :ref:`bool` enabled **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_plugin_enabled` **(** :ref:`String` plugin, :ref:`bool` enabled **)** | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop_playing_scene` **(** **)** | @@ -145,6 +143,23 @@ Property Descriptions If ``true``, enables distraction-free mode which hides side docks to increase the space available for the main view. +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorInterface_property_movie_maker_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **movie_maker_enabled** + +.. rst-class:: classref-property-setget + +- void **set_movie_maker_enabled** **(** :ref:`bool` value **)** +- :ref:`bool` **is_movie_maker_enabled** **(** **)** + +If ``true``, the Movie Maker mode is enabled in the editor. See :ref:`MovieWriter` for more information. + .. rst-class:: classref-section-separator ---- @@ -194,7 +209,7 @@ Edits the given :ref:`Script`. The line and column on which to ope .. rst-class:: classref-method -:ref:`Control` **get_base_control** **(** **)** +:ref:`Control` **get_base_control** **(** **)** |const| Returns the main container of Godot editor's window. For example, you can use it to retrieve the size of the container and place your controls accordingly. @@ -246,7 +261,7 @@ Returns the current path being viewed in the :ref:`FileSystemDock` **get_edited_scene_root** **(** **)** +:ref:`Node` **get_edited_scene_root** **(** **)** |const| Returns the edited (current) scene's root :ref:`Node`. @@ -258,7 +273,7 @@ Returns the edited (current) scene's root :ref:`Node`. .. rst-class:: classref-method -:ref:`VBoxContainer` **get_editor_main_screen** **(** **)** +:ref:`VBoxContainer` **get_editor_main_screen** **(** **)** |const| Returns the editor control responsible for main screen plugins and tools. Use it with plugins that implement :ref:`EditorPlugin._has_main_screen`. @@ -272,7 +287,7 @@ Returns the editor control responsible for main screen plugins and tools. Use it .. rst-class:: classref-method -:ref:`EditorPaths` **get_editor_paths** **(** **)** +:ref:`EditorPaths` **get_editor_paths** **(** **)** |const| Returns the :ref:`EditorPaths` singleton. @@ -298,7 +313,7 @@ Returns the actual scale of the editor UI (``1.0`` being 100% scale). This can b .. rst-class:: classref-method -:ref:`EditorSettings` **get_editor_settings** **(** **)** +:ref:`EditorSettings` **get_editor_settings** **(** **)** |const| Returns the editor's :ref:`EditorSettings` instance. @@ -310,7 +325,7 @@ Returns the editor's :ref:`EditorSettings` instance. .. rst-class:: classref-method -:ref:`FileSystemDock` **get_file_system_dock** **(** **)** +:ref:`FileSystemDock` **get_file_system_dock** **(** **)** |const| Returns the editor's :ref:`FileSystemDock` instance. @@ -362,7 +377,7 @@ Returns the name of the scene that is being played. If no scene is currently bei .. rst-class:: classref-method -:ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** +:ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** |const| Returns the editor's :ref:`EditorFileSystem` instance. @@ -374,7 +389,7 @@ Returns the editor's :ref:`EditorFileSystem` instance. .. rst-class:: classref-method -:ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** +:ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** |const| Returns the editor's :ref:`EditorResourcePreview` instance. @@ -386,7 +401,7 @@ Returns the editor's :ref:`EditorResourcePreview` i .. rst-class:: classref-method -:ref:`ScriptEditor` **get_script_editor** **(** **)** +:ref:`ScriptEditor` **get_script_editor** **(** **)** |const| Returns the editor's :ref:`ScriptEditor` instance. @@ -412,7 +427,7 @@ Returns an array containing the paths of the currently selected files (and direc .. rst-class:: classref-method -:ref:`EditorSelection` **get_selection** **(** **)** +:ref:`EditorSelection` **get_selection** **(** **)** |const| Returns the editor's :ref:`EditorSelection` instance. @@ -432,18 +447,6 @@ Shows the given property on the given ``object`` in the editor's Inspector dock. ---- -.. _class_EditorInterface_method_is_movie_maker_enabled: - -.. rst-class:: classref-method - -:ref:`bool` **is_movie_maker_enabled** **(** **)** |const| - -Returns ``true`` if Movie Maker mode is enabled in the editor. See also :ref:`set_movie_maker_enabled`. See :ref:`MovieWriter` for more information. - -.. rst-class:: classref-item-separator - ----- - .. _class_EditorInterface_method_is_playing_scene: .. rst-class:: classref-method @@ -600,18 +603,6 @@ Sets the editor's current main screen to the one specified in ``name``. ``name`` ---- -.. _class_EditorInterface_method_set_movie_maker_enabled: - -.. rst-class:: classref-method - -void **set_movie_maker_enabled** **(** :ref:`bool` enabled **)** - -Sets whether Movie Maker mode is enabled in the editor. See also :ref:`is_movie_maker_enabled`. See :ref:`MovieWriter` for more information. - -.. rst-class:: classref-item-separator - ----- - .. _class_EditorInterface_method_set_plugin_enabled: .. rst-class:: classref-method diff --git a/classes/class_editorpaths.rst b/classes/class_editorpaths.rst index 49406fec22e..fba3d127bf8 100644 --- a/classes/class_editorpaths.rst +++ b/classes/class_editorpaths.rst @@ -155,7 +155,11 @@ Returns the absolute path to the self-contained file that makes the current Godo Returns ``true`` if the editor is marked as self-contained, ``false`` otherwise. When self-contained mode is enabled, user configuration, data and cache files are saved in an ``editor_data/`` folder next to the editor binary. This makes portable usage easier and ensures the Godot editor minimizes file writes outside its own folder. Self-contained mode is not available for exported projects. -Self-contained mode can be enabled by creating a file named ``._sc_`` or ``_sc_`` in the same folder as the editor binary while the editor is not running. See also :ref:`get_self_contained_file`. +Self-contained mode can be enabled by creating a file named ``._sc_`` or ``_sc_`` in the same folder as the editor binary or macOS .app bundle while the editor is not running. See also :ref:`get_self_contained_file`. + +\ **Note:** On macOS, quarantine flag should be manually removed before using self-contained mode, see `Running on macOS `__. + +\ **Note:** On macOS, placing ``_sc_`` or any other file inside .app bundle will break digital signature and make it non-portable, consider placing it in the same folder as the .app bundle instead. \ **Note:** The Steam release of Godot uses self-contained mode by default. diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 1f857e161b1..91a9eb00175 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -1279,7 +1279,7 @@ The callback should have 4 arguments: :ref:`Object` ``undo_redo``, :ref:`EditorInterface` **get_editor_interface** **(** **)** -Returns the :ref:`EditorInterface` object that gives you control over Godot editor's window and its functionalities. +Returns the :ref:`EditorInterface` singleton. It provides access to some parts of the editor GUI as well as various inner states and tools. .. rst-class:: classref-item-separator diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index f42ea520504..6cb08d14339 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -30,13 +30,13 @@ Below shows an example of a basic plugin that will convert an :ref:`ImageTexture extends EditorResourceConversionPlugin - func _handles(resource : Resource): + func _handles(resource: Resource): return resource is ImageTexture func _converts_to(): return "PortableCompressedTexture2D" - func _convert(itex : Resource): + func _convert(itex: Resource): var ptex = PortableCompressedTexture2D.new() ptex.create_from_image(itex.get_image(), PortableCompressedTexture2D.COMPRESSION_MODE_LOSSLESS) return ptex diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index 2d83b93948a..2883c4987b2 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -68,9 +68,9 @@ Methods +-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ | void | :ref:`add_root_node` **(** :ref:`Node` node **)** | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ - | :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | + | :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`get_scene` **(** **)** | + | :ref:`Node` | :ref:`get_scene` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -112,7 +112,7 @@ Adds ``node`` as a child of the root node in the editor context. .. rst-class:: classref-method -:ref:`EditorInterface` **get_editor_interface** **(** **)** +:ref:`EditorInterface` **get_editor_interface** **(** **)** |const| Returns the :ref:`EditorInterface` singleton instance. @@ -124,7 +124,7 @@ Returns the :ref:`EditorInterface` singleton instance. .. rst-class:: classref-method -:ref:`Node` **get_scene** **(** **)** +:ref:`Node` **get_scene** **(** **)** |const| Returns the Editor's currently active scene. diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 0d595ebc72c..1d2b1dee4a3 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -30,7 +30,7 @@ Accessing the settings can be done using the following methods, such as: .. code-tab:: gdscript - var settings = EditorInterface.get_editor_settings() + var settings = get_editor_interface().get_editor_settings() # `settings.set("some/property", 10)` also works as this class overrides `_set()` internally. settings.set_setting("some/property", 10) # `settings.get("some/property")` also works as this class overrides `_get()` internally. @@ -257,6 +257,8 @@ Properties +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`interface/editor/editor_language` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/editor_screen` | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/editor/expand_to_title` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/font_antialiasing` | @@ -275,6 +277,8 @@ Properties +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/editor/mouse_extra_buttons_navigate_history` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/project_manager_screen` | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/editor/save_each_scene_on_quit` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/editor/separate_distraction_mode` | @@ -287,6 +291,8 @@ Properties +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/editor/use_embedded_menu` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/inspector/float_drag_speed` | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/inspector/max_array_dictionary_items_per_page` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/inspector/show_low_level_opentype_features` | @@ -1171,7 +1177,7 @@ The modifier key that must be held to pan in the 3D editor. :ref:`bool` **editors/3d/navigation/warped_mouse_panning** -If ``true``, warps the mouse around the 3D viewport while panning in the 3D editor. This makes it possible to pan over a large area without having to exit panning then mouse the mouse back constantly. +If ``true``, warps the mouse around the 3D viewport while panning in the 3D editor. This makes it possible to pan over a large area without having to exit panning and adjust the mouse cursor. .. rst-class:: classref-item-separator @@ -1485,7 +1491,7 @@ Controls whether the mouse wheel scroll zooms or pans in subeditors. The list of :ref:`bool` **editors/panning/warped_mouse_panning** -If ``true``, warps the mouse around the 2D viewport while panning in the 2D editor. This makes it possible to pan over a large area without having to exit panning then mouse the mouse back constantly. +If ``true``, warps the mouse around the 2D viewport while panning in the 2D editor. This makes it possible to pan over a large area without having to exit panning and adjust the mouse cursor. .. rst-class:: classref-item-separator @@ -1871,6 +1877,18 @@ Translations are provided by the community. If you spot a mistake, :doc:`contrib ---- +.. _class_EditorSettings_property_interface/editor/editor_screen: + +.. rst-class:: classref-property + +:ref:`int` **interface/editor/editor_screen** + +The preferred monitor to display the editor. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/editor/expand_to_title: .. rst-class:: classref-property @@ -1989,13 +2007,25 @@ If ``true``, the mouse's additional side buttons will be usable to navigate in t ---- +.. _class_EditorSettings_property_interface/editor/project_manager_screen: + +.. rst-class:: classref-property + +:ref:`int` **interface/editor/project_manager_screen** + +The preferred monitor to display the project manager. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/editor/save_each_scene_on_quit: .. rst-class:: classref-property :ref:`bool` **interface/editor/save_each_scene_on_quit** -If ``true``, the editor will save all scenes when confirming the **Save** action when quitting the editor or quitting to the project list. If ``false``, the editor will ask to save each scene individually. +If ``false``, the editor will save all scenes when confirming the **Save** action when quitting the editor or quitting to the project list. If ``true``, the editor will ask to save each scene individually. .. rst-class:: classref-item-separator @@ -2065,6 +2095,18 @@ Specific to the macOS platform. ---- +.. _class_EditorSettings_property_interface/inspector/float_drag_speed: + +.. rst-class:: classref-property + +:ref:`float` **interface/inspector/float_drag_speed** + +Base speed for increasing/decreasing float values by dragging them in the inspector. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/inspector/max_array_dictionary_items_per_page: .. rst-class:: classref-property @@ -2533,7 +2575,7 @@ If ``true``, makes the caret blink according to :ref:`text_editor/appearance/car :ref:`float` **text_editor/appearance/caret/caret_blink_interval** -The interval at which to blink the caret (in seconds). See also :ref:`text_editor/appearance/caret/caret_blink`. +The interval at which the caret will blink (in seconds). See also :ref:`text_editor/appearance/caret/caret_blink`. .. rst-class:: classref-item-separator @@ -3646,7 +3688,7 @@ Erases the setting whose name is specified by ``property``. :ref:`PackedStringArray` **get_changed_settings** **(** **)** |const| -Gets an array of the settings which have been changed since the last save. Note that internally ``changed_settings`` is cleared after a successful save, so generally the most appropriate place to use this method is when processing :ref:`NOTIFICATION_EDITOR_SETTINGS_CHANGED` +Gets an array of the settings which have been changed since the last save. Note that internally ``changed_settings`` is cleared after a successful save, so generally the most appropriate place to use this method is when processing :ref:`NOTIFICATION_EDITOR_SETTINGS_CHANGED`. .. rst-class:: classref-item-separator diff --git a/classes/class_editorundoredomanager.rst b/classes/class_editorundoredomanager.rst index 65b8769748c..02305cd2512 100644 --- a/classes/class_editorundoredomanager.rst +++ b/classes/class_editorundoredomanager.rst @@ -31,6 +31,10 @@ The usage is mostly the same as :ref:`UndoRedo`. You create and This guessing can sometimes yield false results, so you can provide a custom context object when creating an action. +\ **EditorUndoRedoManager** is intended to be used by Godot editor plugins. You can obtain it using :ref:`EditorPlugin.get_undo_redo`. For non-editor uses or plugins that don't need to integrate with the editor's undo history, use :ref:`UndoRedo` instead. + +The manager's API is mostly the same as in :ref:`UndoRedo`, so you can refer to its documentation for more examples. The main difference is that **EditorUndoRedoManager** uses object + method name for actions, instead of :ref:`Callable`. + .. rst-class:: classref-reftable-group Methods diff --git a/classes/class_editorvcsinterface.rst b/classes/class_editorvcsinterface.rst index bd9c61f46fa..800821fc555 100644 --- a/classes/class_editorvcsinterface.rst +++ b/classes/class_editorvcsinterface.rst @@ -265,7 +265,7 @@ Discards the changes made in a file present at ``file_path``. void **_fetch** **(** :ref:`String` remote **)** |virtual| -Fetches new changes from the remote, but doesn't write changes to the current working directory. Equivalent to ``git fetch``. +Fetches new changes from the ``remote``, but doesn't write changes to the current working directory. Equivalent to ``git fetch``. .. rst-class:: classref-item-separator @@ -397,7 +397,7 @@ Pulls changes from the remote. This can give rise to merge conflicts. void **_push** **(** :ref:`String` remote, :ref:`bool` force **)** |virtual| -Pushes changes to the ``remote``. Optionally, if ``force`` is set to true, a force push will override the change history already present on the remote. +Pushes changes to the ``remote``. If ``force`` is ``true``, a force push will override the change history already present on the remote. .. rst-class:: classref-item-separator @@ -517,7 +517,7 @@ Helper function to create a commit :ref:`Dictionary` item. ``m :ref:`Dictionary` **create_diff_file** **(** :ref:`String` new_file, :ref:`String` old_file **)** -Helper function to create a ``Dictionary`` for storing old and new diff file paths. +Helper function to create a :ref:`Dictionary` for storing old and new diff file paths. .. rst-class:: classref-item-separator @@ -529,7 +529,7 @@ Helper function to create a ``Dictionary`` for storing old and new diff file pat :ref:`Dictionary` **create_diff_hunk** **(** :ref:`int` old_start, :ref:`int` new_start, :ref:`int` old_lines, :ref:`int` new_lines **)** -Helper function to create a ``Dictionary`` for storing diff hunk data. ``old_start`` is the starting line number in old file. ``new_start`` is the starting line number in new file. ``old_lines`` is the number of lines in the old file. ``new_lines`` is the number of lines in the new file. +Helper function to create a :ref:`Dictionary` for storing diff hunk data. ``old_start`` is the starting line number in old file. ``new_start`` is the starting line number in new file. ``old_lines`` is the number of lines in the old file. ``new_lines`` is the number of lines in the new file. .. rst-class:: classref-item-separator @@ -541,7 +541,7 @@ Helper function to create a ``Dictionary`` for storing diff hunk data. ``old_sta :ref:`Dictionary` **create_diff_line** **(** :ref:`int` new_line_no, :ref:`int` old_line_no, :ref:`String` content, :ref:`String` status **)** -Helper function to create a ``Dictionary`` for storing a line diff. ``new_line_no`` is the line number in the new file (can be ``-1`` if the line is deleted). ``old_line_no`` is the line number in the old file (can be ``-1`` if the line is added). ``content`` is the diff text. ``status`` is a single character string which stores the line origin. +Helper function to create a :ref:`Dictionary` for storing a line diff. ``new_line_no`` is the line number in the new file (can be ``-1`` if the line is deleted). ``old_line_no`` is the line number in the old file (can be ``-1`` if the line is added). ``content`` is the diff text. ``status`` is a single character string which stores the line origin. .. rst-class:: classref-item-separator @@ -553,7 +553,7 @@ Helper function to create a ``Dictionary`` for storing a line diff. ``new_line_n :ref:`Dictionary` **create_status_file** **(** :ref:`String` file_path, :ref:`ChangeType` change_type, :ref:`TreeArea` area **)** -Helper function to create a ``Dictionary`` used by editor to read the status of a file. +Helper function to create a :ref:`Dictionary` used by editor to read the status of a file. .. rst-class:: classref-item-separator diff --git a/classes/class_enetpacketpeer.rst b/classes/class_enetpacketpeer.rst index 7ec0f53f922..250974a1441 100644 --- a/classes/class_enetpacketpeer.rst +++ b/classes/class_enetpacketpeer.rst @@ -511,7 +511,7 @@ void **set_timeout** **(** :ref:`int` timeout, :ref:`int` Sets the timeout parameters for a peer. The timeout parameters control how and when a peer will timeout from a failure to acknowledge reliable traffic. Timeout values are expressed in milliseconds. -The ``timeout_limit`` is a factor that, multiplied by a value based on the average round trip time, will determine the timeout limit for a reliable packet. When that limit is reached, the timeout will be doubled, and the peer will be disconnected if that limit has reached ``timeout_min``. The ``timeout_max`` parameter, on the other hand, defines a fixed timeout for which any packet must be acknowledged or the peer will be dropped. +The ``timeout`` is a factor that, multiplied by a value based on the average round trip time, will determine the timeout limit for a reliable packet. When that limit is reached, the timeout will be doubled, and the peer will be disconnected if that limit has reached ``timeout_min``. The ``timeout_max`` parameter, on the other hand, defines a fixed timeout for which any packet must be acknowledged or the peer will be dropped. .. rst-class:: classref-item-separator diff --git a/classes/class_engine.rst b/classes/class_engine.rst index b4c1b120914..7c4ec586704 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -226,7 +226,7 @@ If ``false``, stops printing error and warning messages to the console and edito - void **set_time_scale** **(** :ref:`float` value **)** - :ref:`float` **get_time_scale** **(** **)** -Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. +Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. This also affects :ref:`Timer` and :ref:`SceneTreeTimer` (see :ref:`SceneTree.create_timer` for how to control this). .. rst-class:: classref-section-separator diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 17744e72589..a64b0b09c1a 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -1858,7 +1858,7 @@ If ``true``, screen-space reflections are enabled. Screen-space reflections are - void **set_ssr_fade_in** **(** :ref:`float` value **)** - :ref:`float` **get_ssr_fade_in** **(** **)** -The fade-in distance for screen-space reflections. Affects the area from the reflected material to the screen-space reflection). Only positive values are valid (negative values will be clamped to ``0.0``). +The fade-in distance for screen-space reflections. Affects the area from the reflected material to the screen-space reflection. Only positive values are valid (negative values will be clamped to ``0.0``). .. rst-class:: classref-item-separator diff --git a/classes/class_expression.rst b/classes/class_expression.rst index 8336ab8b7cf..a6f282605d2 100644 --- a/classes/class_expression.rst +++ b/classes/class_expression.rst @@ -70,6 +70,13 @@ In the following example we use a :ref:`LineEdit` node to write +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Evaluating Expressions <../tutorials/scripting/evaluating_expressions>` + .. rst-class:: classref-reftable-group Methods diff --git a/classes/class_fileaccess.rst b/classes/class_fileaccess.rst index 9e4645e80bd..00979eaa92b 100644 --- a/classes/class_fileaccess.rst +++ b/classes/class_fileaccess.rst @@ -293,6 +293,14 @@ Uses the `Zstandard `__ compression method. Uses the `gzip `__ compression method. +.. _class_FileAccess_constant_COMPRESSION_BROTLI: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompressionMode` **COMPRESSION_BROTLI** = ``4`` + +Uses the `brotli `__ compression method (only decompression is supported). + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index eeb04d811c5..9ab009a9158 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -255,7 +255,7 @@ Property Descriptions - void **set_access** **(** :ref:`Access` value **)** - :ref:`Access` **get_access** **(** **)** -The file system access scope. See enum ``Access`` constants. +The file system access scope. See :ref:`Access` constants. \ **Warning:** Currently, in sandboxed environments such as Web builds or sandboxed macOS apps, FileDialog cannot access the host file system. See `godot-proposals#1123 `__. @@ -359,7 +359,7 @@ The available file type filters. For example, this shows only ``.png`` and ``.gd - void **set_mode_overrides_title** **(** :ref:`bool` value **)** - :ref:`bool` **is_mode_overriding_title** **(** **)** -If ``true``, changing the ``Mode`` property will set the window title accordingly (e.g. setting mode to :ref:`FILE_MODE_OPEN_FILE` will change the window title to "Open a File"). +If ``true``, changing the :ref:`file_mode` property will set the window title accordingly (e.g. setting :ref:`file_mode` to :ref:`FILE_MODE_OPEN_FILE` will change the window title to "Open a File"). .. rst-class:: classref-item-separator diff --git a/classes/class_filesystemdock.rst b/classes/class_filesystemdock.rst index 32bcd0c19c5..b28d1fd2c08 100644 --- a/classes/class_filesystemdock.rst +++ b/classes/class_filesystemdock.rst @@ -12,9 +12,16 @@ FileSystemDock **Inherits:** :ref:`VBoxContainer` **<** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -.. container:: contribute +Editor dock for managing files in the project. - There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Description +----------- + +This class is available only in :ref:`EditorPlugin`\ s and can't be instantiated. You can access it using :ref:`EditorInterface.get_file_system_dock`. + +While FileSystemDock doesn't expose any methods for file manipulation, you can listen for various file-related signals. .. rst-class:: classref-reftable-group @@ -43,9 +50,7 @@ Signals **display_mode_changed** **(** **)** -.. container:: contribute - - There is currently no description for this signal. Please help us by :ref:`contributing one `! +Emitted when the user switches file display mode or split mode. .. rst-class:: classref-item-separator @@ -57,9 +62,7 @@ Signals **file_removed** **(** :ref:`String` file **)** -.. container:: contribute - - There is currently no description for this signal. Please help us by :ref:`contributing one `! +Emitted when the given ``file`` was removed. .. rst-class:: classref-item-separator @@ -71,9 +74,7 @@ Signals **files_moved** **(** :ref:`String` old_file, :ref:`String` new_file **)** -.. container:: contribute - - There is currently no description for this signal. Please help us by :ref:`contributing one `! +Emitted when a file is moved from ``old_file`` path to ``new_file`` path. .. rst-class:: classref-item-separator @@ -85,9 +86,7 @@ Signals **folder_moved** **(** :ref:`String` old_folder, :ref:`String` new_folder **)** -.. container:: contribute - - There is currently no description for this signal. Please help us by :ref:`contributing one `! +Emitted when a folder is moved from ``old_folder`` path to ``new_folder`` path. .. rst-class:: classref-item-separator @@ -99,9 +98,7 @@ Signals **folder_removed** **(** :ref:`String` folder **)** -.. container:: contribute - - There is currently no description for this signal. Please help us by :ref:`contributing one `! +Emitted when the given ``folder`` was removed. .. rst-class:: classref-item-separator @@ -113,9 +110,7 @@ Signals **inherit** **(** :ref:`String` file **)** -.. container:: contribute - - There is currently no description for this signal. Please help us by :ref:`contributing one `! +Emitted when a new scene is created that inherits the scene at ``file`` path. .. rst-class:: classref-item-separator @@ -127,9 +122,7 @@ Signals **instantiate** **(** :ref:`PackedStringArray` files **)** -.. container:: contribute - - There is currently no description for this signal. Please help us by :ref:`contributing one `! +Emitted when the given scenes are being instantiated in the editor. .. rst-class:: classref-item-separator @@ -141,9 +134,7 @@ Signals **resource_removed** **(** :ref:`Resource` resource **)** -.. container:: contribute - - There is currently no description for this signal. Please help us by :ref:`contributing one `! +Emitted when an external ``resource`` had its file removed. .. rst-class:: classref-section-separator @@ -160,9 +151,7 @@ Method Descriptions void **navigate_to_path** **(** :ref:`String` path **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the given ``path`` as currently selected, ensuring that the selected file/directory is visible. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_font.rst b/classes/class_font.rst index 54a2f5069e8..a9b12fa5dc4 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -462,6 +462,20 @@ Returns list of supported `variation coordinates `, use :ref:`FontVariation.variation_opentype`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_fontfile.rst b/classes/class_fontfile.rst index 97f5c0b27a0..8132ecd1b45 100644 --- a/classes/class_fontfile.rst +++ b/classes/class_fontfile.rst @@ -135,6 +135,8 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_cache_underline_thickness` **(** :ref:`int` cache_index, :ref:`int` size **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_char_from_glyph_index` **(** :ref:`int` size, :ref:`int` glyph_index **)** |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_embolden` **(** :ref:`int` cache_index **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_face_index` **(** :ref:`int` cache_index **)** |const| | @@ -715,6 +717,18 @@ Returns thickness of the underline in pixels. ---- +.. _class_FontFile_method_get_char_from_glyph_index: + +.. rst-class:: classref-method + +:ref:`int` **get_char_from_glyph_index** **(** :ref:`int` size, :ref:`int` glyph_index **)** |const| + +Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_index`` is invalid. See :ref:`get_glyph_index`. + +.. rst-class:: classref-item-separator + +---- + .. _class_FontFile_method_get_embolden: .. rst-class:: classref-method diff --git a/classes/class_fontvariation.rst b/classes/class_fontvariation.rst index 5e3c66edd5f..ed48d8300ad 100644 --- a/classes/class_fontvariation.rst +++ b/classes/class_fontvariation.rst @@ -44,6 +44,15 @@ To use simulated bold font variant: +To set the coordinate of multiple variation axes: + +:: + + var fv = FontVariation.new(); + var ts = TextServerManager.get_primary_interface() + fv.base_font = load("res://BarlowCondensed-Regular.ttf") + fv.variation_opentype = { ts.name_to_tag("wght"): 900, ts.name_to_tag("custom_hght"): 900 } + .. rst-class:: classref-reftable-group Properties @@ -125,7 +134,7 @@ Base font used to create a variation. If not set, default :ref:`Theme` value **)** - :ref:`Font[]` **get_fallbacks** **(** **)** -Array of fallback :ref:`Font`\ s. If not set :ref:`base_font` fallback are ussed. +Array of fallback :ref:`Font`\ s to use as a substitute if a glyph is not found in this **FontVariation**. If not set, :ref:`base_font`'s fallbacks are used instead. .. rst-class:: classref-item-separator @@ -265,6 +274,10 @@ Active face index in the TrueType / OpenType collection file. Font OpenType variation coordinates. More info: `OpenType variation tags `__. +\ **Note:** This :ref:`Dictionary` uses OpenType tags as keys. Variation axes can be identified both by tags(``int``) and names (``string``). Some axes might be accessible by multiple names. For example, ``wght`` refers to the same axis as ``weight``. Tags on the other hand are unique. To convert between names and tags, use :ref:`TextServer.name_to_tag` and :ref:`TextServer.tag_to_name`. + +\ **Note:** To get available variation axes of a font, use :ref:`Font.get_supported_variation_list`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_gltfcollider.rst b/classes/class_gltfcollider.rst new file mode 100644 index 00000000000..a88b254a0e1 --- /dev/null +++ b/classes/class_gltfcollider.rst @@ -0,0 +1,257 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFCollider.xml. + +.. _class_GLTFCollider: + +GLTFCollider +============ + +**Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +Represents a GLTF collider. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Represents a collider as defined by the ``OMI_collider`` GLTF extension. This class is an intermediary between the GLTF data and Godot's nodes, and it's abstracted in a way that allows adding support for different GLTF physics extensions in the future. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- `OMI_collider GLTF extension `__ + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------------------------+-----------------------------------------------------------------+----------------------+ + | :ref:`float` | :ref:`height` | ``2.0`` | + +-----------------------------------------+-----------------------------------------------------------------+----------------------+ + | :ref:`ImporterMesh` | :ref:`importer_mesh` | | + +-----------------------------------------+-----------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`is_trigger` | ``false`` | + +-----------------------------------------+-----------------------------------------------------------------+----------------------+ + | :ref:`int` | :ref:`mesh_index` | ``-1`` | + +-----------------------------------------+-----------------------------------------------------------------+----------------------+ + | :ref:`float` | :ref:`radius` | ``0.5`` | + +-----------------------------------------+-----------------------------------------------------------------+----------------------+ + | :ref:`String` | :ref:`shape_type` | ``""`` | + +-----------------------------------------+-----------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`size` | ``Vector3(1, 1, 1)`` | + +-----------------------------------------+-----------------------------------------------------------------+----------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GLTFCollider` | :ref:`from_dictionary` **(** :ref:`Dictionary` dictionary **)** |static| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GLTFCollider` | :ref:`from_node` **(** :ref:`CollisionShape3D` collider_node **)** |static| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`to_dictionary` **(** **)** |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CollisionShape3D` | :ref:`to_node` **(** :ref:`bool` cache_shapes=false **)** | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_GLTFCollider_property_height: + +.. rst-class:: classref-property + +:ref:`float` **height** = ``2.0`` + +.. rst-class:: classref-property-setget + +- void **set_height** **(** :ref:`float` value **)** +- :ref:`float` **get_height** **(** **)** + +The height of the collider, in meters. This is only used when the collider type is "capsule" or "cylinder". This value should not be negative, and for "capsule" it should be at least twice the radius. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_property_importer_mesh: + +.. rst-class:: classref-property + +:ref:`ImporterMesh` **importer_mesh** + +.. rst-class:: classref-property-setget + +- void **set_importer_mesh** **(** :ref:`ImporterMesh` value **)** +- :ref:`ImporterMesh` **get_importer_mesh** **(** **)** + +The :ref:`ImporterMesh` resource of the collider. This is only used when the collider type is "hull" (convex hull) or "trimesh" (concave trimesh). + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_property_is_trigger: + +.. rst-class:: classref-property + +:ref:`bool` **is_trigger** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_is_trigger** **(** :ref:`bool` value **)** +- :ref:`bool` **get_is_trigger** **(** **)** + +If ``true``, indicates that this collider is a trigger. For Godot, this means that the collider should be a child of an Area3D node. + +This is the only variable not used in the :ref:`to_node` method, it's intended to be used alongside when deciding where to add the generated node as a child. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_property_mesh_index: + +.. rst-class:: classref-property + +:ref:`int` **mesh_index** = ``-1`` + +.. rst-class:: classref-property-setget + +- void **set_mesh_index** **(** :ref:`int` value **)** +- :ref:`int` **get_mesh_index** **(** **)** + +The index of the collider's mesh in the GLTF file. This is only used when the collider type is "hull" (convex hull) or "trimesh" (concave trimesh). + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_property_radius: + +.. rst-class:: classref-property + +:ref:`float` **radius** = ``0.5`` + +.. rst-class:: classref-property-setget + +- void **set_radius** **(** :ref:`float` value **)** +- :ref:`float` **get_radius** **(** **)** + +The radius of the collider, in meters. This is only used when the collider type is "capsule", "cylinder", or "sphere". This value should not be negative. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_property_shape_type: + +.. rst-class:: classref-property + +:ref:`String` **shape_type** = ``""`` + +.. rst-class:: classref-property-setget + +- void **set_shape_type** **(** :ref:`String` value **)** +- :ref:`String` **get_shape_type** **(** **)** + +The type of shape this collider represents. Valid values are "box", "capsule", "cylinder", "sphere", "hull", and "trimesh". + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_property_size: + +.. rst-class:: classref-property + +:ref:`Vector3` **size** = ``Vector3(1, 1, 1)`` + +.. rst-class:: classref-property-setget + +- void **set_size** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_size** **(** **)** + +The size of the collider, in meters. This is only used when the collider type is "box", and it represents the "diameter" of the box. This value should not be negative. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_GLTFCollider_method_from_dictionary: + +.. rst-class:: classref-method + +:ref:`GLTFCollider` **from_dictionary** **(** :ref:`Dictionary` dictionary **)** |static| + +Creates a new GLTFCollider instance by parsing the given :ref:`Dictionary`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_method_from_node: + +.. rst-class:: classref-method + +:ref:`GLTFCollider` **from_node** **(** :ref:`CollisionShape3D` collider_node **)** |static| + +Create a new GLTFCollider instance from the given Godot :ref:`CollisionShape3D` node. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_method_to_dictionary: + +.. rst-class:: classref-method + +:ref:`Dictionary` **to_dictionary** **(** **)** |const| + +Serializes this GLTFCollider instance into a :ref:`Dictionary`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_method_to_node: + +.. rst-class:: classref-method + +:ref:`CollisionShape3D` **to_node** **(** :ref:`bool` cache_shapes=false **)** + +Converts this GLTFCollider instance into a Godot :ref:`CollisionShape3D` node. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_gltfnode.rst b/classes/class_gltfnode.rst index dd743c718b2..342468c5233 100644 --- a/classes/class_gltfnode.rst +++ b/classes/class_gltfnode.rst @@ -21,6 +21,8 @@ Description Represents a GLTF node. GLTF nodes may have names, transforms, children (other GLTF nodes), and more specialized properties (represented by their own classes). +GLTF nodes generally exist inside of :ref:`GLTFState` which represents all data of a GLTF file. Most of GLTFNode's properties are indices of other data in the GLTF file. You can extend a GLTF node with additional properties by using :ref:`get_additional_data` and :ref:`set_additional_data`. + .. rst-class:: classref-introduction-group Tutorials @@ -96,9 +98,7 @@ Property Descriptions - void **set_camera** **(** :ref:`int` value **)** - :ref:`int` **get_camera** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If this GLTF node is a camera, the index of the :ref:`GLTFCamera` in the :ref:`GLTFState` that describes the camera's properties. If -1, this node is not a camera. .. rst-class:: classref-item-separator @@ -115,9 +115,7 @@ Property Descriptions - void **set_children** **(** :ref:`PackedInt32Array` value **)** - :ref:`PackedInt32Array` **get_children** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The indices of the children nodes in the :ref:`GLTFState`. If this GLTF node has no children, this will be an empty array. .. rst-class:: classref-item-separator @@ -134,9 +132,7 @@ Property Descriptions - void **set_height** **(** :ref:`int` value **)** - :ref:`int` **get_height** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +How deep into the node hierarchy this node is. A root node will have a height of 0, its children will have a height of 1, and so on. If -1, the height has not been calculated. .. rst-class:: classref-item-separator @@ -153,9 +149,7 @@ Property Descriptions - void **set_light** **(** :ref:`int` value **)** - :ref:`int` **get_light** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If this GLTF node is a light, the index of the :ref:`GLTFLight` in the :ref:`GLTFState` that describes the light's properties. If -1, this node is not a light. .. rst-class:: classref-item-separator @@ -172,9 +166,7 @@ Property Descriptions - void **set_mesh** **(** :ref:`int` value **)** - :ref:`int` **get_mesh** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If this GLTF node is a mesh, the index of the :ref:`GLTFMesh` in the :ref:`GLTFState` that describes the mesh's properties. If -1, this node is not a mesh. .. rst-class:: classref-item-separator @@ -191,9 +183,7 @@ Property Descriptions - void **set_parent** **(** :ref:`int` value **)** - :ref:`int` **get_parent** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The index of the parent node in the :ref:`GLTFState`. If -1, this node is a root node. .. rst-class:: classref-item-separator @@ -210,9 +200,7 @@ Property Descriptions - void **set_position** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_position** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The position of the GLTF node relative to its parent. .. rst-class:: classref-item-separator @@ -229,9 +217,7 @@ Property Descriptions - void **set_rotation** **(** :ref:`Quaternion` value **)** - :ref:`Quaternion` **get_rotation** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The rotation of the GLTF node relative to its parent. .. rst-class:: classref-item-separator @@ -248,9 +234,7 @@ Property Descriptions - void **set_scale** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_scale** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The scale of the GLTF node relative to its parent. .. rst-class:: classref-item-separator @@ -267,9 +251,7 @@ Property Descriptions - void **set_skeleton** **(** :ref:`int` value **)** - :ref:`int` **get_skeleton** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If this GLTF node has a skeleton, the index of the :ref:`GLTFSkeleton` in the :ref:`GLTFState` that describes the skeleton's properties. If -1, this node does not have a skeleton. .. rst-class:: classref-item-separator @@ -286,9 +268,7 @@ Property Descriptions - void **set_skin** **(** :ref:`int` value **)** - :ref:`int` **get_skin** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If this GLTF node has a skin, the index of the :ref:`GLTFSkin` in the :ref:`GLTFState` that describes the skin's properties. If -1, this node does not have a skin. .. rst-class:: classref-item-separator @@ -305,9 +285,7 @@ Property Descriptions - void **set_xform** **(** :ref:`Transform3D` value **)** - :ref:`Transform3D` **get_xform** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The transform of the GLTF node relative to its parent. This property is usually unused since the position, rotation, and scale properties are preferred. .. rst-class:: classref-section-separator diff --git a/classes/class_gltfphysicsbody.rst b/classes/class_gltfphysicsbody.rst new file mode 100644 index 00000000000..619b7031a7f --- /dev/null +++ b/classes/class_gltfphysicsbody.rst @@ -0,0 +1,219 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFPhysicsBody.xml. + +.. _class_GLTFPhysicsBody: + +GLTFPhysicsBody +=============== + +**Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +Represents a GLTF physics body. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Represents a physics body as defined by the ``OMI_physics_body`` GLTF extension. This class is an intermediary between the GLTF data and Godot's nodes, and it's abstracted in a way that allows adding support for different GLTF physics extensions in the future. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- `OMI_physics_body GLTF extension `__ + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------------+--------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`angular_velocity` | ``Vector3(0, 0, 0)`` | + +-------------------------------+--------------------------------------------------------------------------+----------------------+ + | :ref:`String` | :ref:`body_type` | ``"static"`` | + +-------------------------------+--------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`inertia` | ``Vector3(0, 0, 0)`` | + +-------------------------------+--------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`linear_velocity` | ``Vector3(0, 0, 0)`` | + +-------------------------------+--------------------------------------------------------------------------+----------------------+ + | :ref:`float` | :ref:`mass` | ``1.0`` | + +-------------------------------+--------------------------------------------------------------------------+----------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GLTFPhysicsBody` | :ref:`from_dictionary` **(** :ref:`Dictionary` dictionary **)** |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GLTFPhysicsBody` | :ref:`from_node` **(** :ref:`CollisionObject3D` body_node **)** |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`to_dictionary` **(** **)** |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CollisionObject3D` | :ref:`to_node` **(** **)** |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_GLTFPhysicsBody_property_angular_velocity: + +.. rst-class:: classref-property + +:ref:`Vector3` **angular_velocity** = ``Vector3(0, 0, 0)`` + +.. rst-class:: classref-property-setget + +- void **set_angular_velocity** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_angular_velocity** **(** **)** + +The angular velocity of the physics body, in radians per second. This is only used when the body type is "rigid" or "vehicle". + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFPhysicsBody_property_body_type: + +.. rst-class:: classref-property + +:ref:`String` **body_type** = ``"static"`` + +.. rst-class:: classref-property-setget + +- void **set_body_type** **(** :ref:`String` value **)** +- :ref:`String` **get_body_type** **(** **)** + +The type of the body. Valid values are "static", "kinematic", "character", "rigid", "vehicle", and "trigger". + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFPhysicsBody_property_inertia: + +.. rst-class:: classref-property + +:ref:`Vector3` **inertia** = ``Vector3(0, 0, 0)`` + +.. rst-class:: classref-property-setget + +- void **set_inertia** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_inertia** **(** **)** + +The principle axes of the inertia tensor of the physics body, in kilogram meter squared (kg⋅m²). This is only used when the body type is "rigid" or "vehicle". + +This is written to and read from the GLTF file as a 3x3 matrix, but is exposed as a Vector3 since Godot only supports principal axis inertia values. When converted to a Godot :ref:`RigidBody3D` node, if this value is zero, then the inertia will be calculated automatically. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFPhysicsBody_property_linear_velocity: + +.. rst-class:: classref-property + +:ref:`Vector3` **linear_velocity** = ``Vector3(0, 0, 0)`` + +.. rst-class:: classref-property-setget + +- void **set_linear_velocity** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_linear_velocity** **(** **)** + +The linear velocity of the physics body, in meters per second. This is only used when the body type is "rigid" or "vehicle". + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFPhysicsBody_property_mass: + +.. rst-class:: classref-property + +:ref:`float` **mass** = ``1.0`` + +.. rst-class:: classref-property-setget + +- void **set_mass** **(** :ref:`float` value **)** +- :ref:`float` **get_mass** **(** **)** + +The mass of the physics body, in kilograms. This is only used when the body type is "rigid" or "vehicle". + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_GLTFPhysicsBody_method_from_dictionary: + +.. rst-class:: classref-method + +:ref:`GLTFPhysicsBody` **from_dictionary** **(** :ref:`Dictionary` dictionary **)** |static| + +Creates a new GLTFPhysicsBody instance by parsing the given :ref:`Dictionary`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFPhysicsBody_method_from_node: + +.. rst-class:: classref-method + +:ref:`GLTFPhysicsBody` **from_node** **(** :ref:`CollisionObject3D` body_node **)** |static| + +Create a new GLTFPhysicsBody instance from the given Godot :ref:`CollisionObject3D` node. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFPhysicsBody_method_to_dictionary: + +.. rst-class:: classref-method + +:ref:`Dictionary` **to_dictionary** **(** **)** |const| + +Serializes this GLTFPhysicsBody instance into a :ref:`Dictionary`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFPhysicsBody_method_to_node: + +.. rst-class:: classref-method + +:ref:`CollisionObject3D` **to_node** **(** **)** |const| + +Converts this GLTFPhysicsBody instance into a Godot :ref:`CollisionObject3D` node. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_gltfstate.rst b/classes/class_gltfstate.rst index f30b1953530..a47f9d000c6 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -12,9 +12,16 @@ GLTFState **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -.. container:: contribute +Represents all data of a GLTF file. + +.. rst-class:: classref-introduction-group + +Description +----------- - There is currently no description for this class. Please help us by :ref:`contributing one `! +Contains all nodes and resources of a GLTF file. This is used by :ref:`GLTFDocument` as data storage, which allows :ref:`GLTFDocument` and all :ref:`GLTFDocumentExtension` classes to remain stateless. + +GLTFState can be populated by :ref:`GLTFDocument` reading a file or by converting a Godot scene. Then the data can either be used to create a Godot scene or save to a GLTF file. The code that converts to/from a Godot scene can be intercepted at arbitrary points by :ref:`GLTFDocumentExtension` classes. This allows for custom data to be stored in the GLTF file or for custom data to be converted to/from Godot nodes. .. rst-class:: classref-reftable-group @@ -326,9 +333,7 @@ Property Descriptions - void **set_root_nodes** **(** :ref:`PackedInt32Array` value **)** - :ref:`PackedInt32Array` **get_root_nodes** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The root nodes of the GLTF file. Typically, a GLTF file will only have one scene, and therefore one root node. However, a GLTF file may have multiple scenes and therefore multiple root nodes, which will be generated as siblings of each other and as children of the root node of the generated Godot scene. .. rst-class:: classref-item-separator @@ -345,9 +350,7 @@ Property Descriptions - void **set_scene_name** **(** :ref:`String` value **)** - :ref:`String` **get_scene_name** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The name of the scene. When importing, if not specified, this will be the file name. When exporting, if specified, the scene name will be saved to the GLTF file. .. rst-class:: classref-item-separator @@ -423,9 +426,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_animation_player** **(** :ref:`int` idx **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the :ref:`AnimationPlayer` node with the given index. These nodes are only used during the export process when converting Godot :ref:`AnimationPlayer` nodes to GLTF animations. .. rst-class:: classref-item-separator @@ -437,9 +438,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_animation_players_count** **(** :ref:`int` idx **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the number of :ref:`AnimationPlayer` nodes in this **GLTFState**. These nodes are only used during the export process when converting Godot :ref:`AnimationPlayer` nodes to GLTF animations. .. rst-class:: classref-item-separator @@ -451,9 +450,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_animations** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of all :ref:`GLTFAnimation`\ s in the GLTF file. When importing, these will be generated as animations in an :ref:`AnimationPlayer` node. When exporting, these will be generated from Godot :ref:`AnimationPlayer` nodes. .. rst-class:: classref-item-separator @@ -479,9 +476,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_cameras** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of all :ref:`GLTFCamera`\ s in the GLTF file. These are the cameras that the :ref:`GLTFNode.camera` index refers to. .. rst-class:: classref-item-separator @@ -521,9 +516,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_lights** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of all :ref:`GLTFLight`\ s in the GLTF file. These are the lights that the :ref:`GLTFNode.light` index refers to. .. rst-class:: classref-item-separator @@ -549,9 +542,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_meshes** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of all :ref:`GLTFMesh`\ es in the GLTF file. These are the meshes that the :ref:`GLTFNode.mesh` index refers to. .. rst-class:: classref-item-separator @@ -563,9 +554,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_nodes** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of all :ref:`GLTFNode`\ s in the GLTF file. These are the nodes that :ref:`GLTFNode.children` and :ref:`root_nodes` refer to. This includes nodes that may not be generated in the Godot scene, or nodes that may generate multiple Godot scene nodes. .. rst-class:: classref-item-separator @@ -577,9 +566,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_scene_node** **(** :ref:`int` idx **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the Godot scene node that corresponds to the same index as the :ref:`GLTFNode` it was generated from. Not every :ref:`GLTFNode` will have a scene node generated, and not every generated scene node will have a corresponding :ref:`GLTFNode`. .. rst-class:: classref-item-separator @@ -591,9 +578,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_skeletons** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of all :ref:`GLTFSkeleton`\ s in the GLTF file. These are the skeletons that the :ref:`GLTFNode.skeleton` index refers to. .. rst-class:: classref-item-separator @@ -605,9 +590,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_skins** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of all :ref:`GLTFSkin`\ s in the GLTF file. These are the skins that the :ref:`GLTFNode.skin` index refers to. .. rst-class:: classref-item-separator @@ -645,9 +628,7 @@ Retrieves the array of texture samplers that are used by the textures contained :ref:`String[]` **get_unique_animation_names** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of unique animation names. This is only used during the import process. .. rst-class:: classref-item-separator @@ -659,9 +640,7 @@ Retrieves the array of texture samplers that are used by the textures contained :ref:`String[]` **get_unique_names** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of unique node names. This is used in both the import process and export process. .. rst-class:: classref-item-separator @@ -701,9 +680,7 @@ The first argument should be the :ref:`GLTFDocumentExtension` animations **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the :ref:`GLTFAnimation`\ s in the state. When importing, these will be generated as animations in an :ref:`AnimationPlayer` node. When exporting, these will be generated from Godot :ref:`AnimationPlayer` nodes. .. rst-class:: classref-item-separator @@ -729,9 +706,7 @@ void **set_buffer_views** **(** :ref:`GLTFBufferView[]` bu void **set_cameras** **(** :ref:`GLTFCamera[]` cameras **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the :ref:`GLTFCamera`\ s in the state. These are the cameras that the :ref:`GLTFNode.camera` index refers to. .. rst-class:: classref-item-separator @@ -771,9 +746,7 @@ void **set_images** **(** :ref:`Texture2D[]` images **)** void **set_lights** **(** :ref:`GLTFLight[]` lights **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the :ref:`GLTFLight`\ s in the state. These are the lights that the :ref:`GLTFNode.light` index refers to. .. rst-class:: classref-item-separator @@ -799,9 +772,7 @@ void **set_materials** **(** :ref:`Material[]` materials **)** void **set_meshes** **(** :ref:`GLTFMesh[]` meshes **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the :ref:`GLTFMesh`\ es in the state. These are the meshes that the :ref:`GLTFNode.mesh` index refers to. .. rst-class:: classref-item-separator @@ -813,9 +784,7 @@ void **set_meshes** **(** :ref:`GLTFMesh[]` meshes **)** void **set_nodes** **(** :ref:`GLTFNode[]` nodes **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the :ref:`GLTFNode`\ s in the state. These are the nodes that :ref:`GLTFNode.children` and :ref:`root_nodes` refer to. Some of the nodes set here may not be generated in the Godot scene, or may generate multiple Godot scene nodes. .. rst-class:: classref-item-separator @@ -827,9 +796,7 @@ void **set_nodes** **(** :ref:`GLTFNode[]` nodes **)** void **set_skeletons** **(** :ref:`GLTFSkeleton[]` skeletons **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the :ref:`GLTFSkeleton`\ s in the state. These are the skeletons that the :ref:`GLTFNode.skeleton` index refers to. .. rst-class:: classref-item-separator @@ -841,9 +808,7 @@ void **set_skeletons** **(** :ref:`GLTFSkeleton[]` skeletons void **set_skins** **(** :ref:`GLTFSkin[]` skins **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the :ref:`GLTFSkin`\ s in the state. These are the skins that the :ref:`GLTFNode.skin` index refers to. .. rst-class:: classref-item-separator @@ -881,9 +846,7 @@ void **set_textures** **(** :ref:`GLTFTexture[]` textures **) void **set_unique_animation_names** **(** :ref:`String[]` unique_animation_names **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the unique animation names in the state. This is only used during the import process. .. rst-class:: classref-item-separator @@ -895,9 +858,7 @@ void **set_unique_animation_names** **(** :ref:`String[]` unique_a void **set_unique_names** **(** :ref:`String[]` unique_names **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the unique node names in the state. This is used in both the import process and export process. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 41059a37fc4..577b425424e 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -239,6 +239,8 @@ void **reverse** **(** **)** Reverses/mirrors the gradient. +\ **Note:** This method mirrors all points around the middle of the gradient, which may produce unexpected results when :ref:`interpolation_mode` is set to :ref:`GRADIENT_INTERPOLATE_CONSTANT`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 0940b2e4656..752fb56f360 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -727,8 +727,8 @@ Below is a sample code to help get started: :: func _is_in_input_hotzone(in_node, in_port, mouse_position): - var port_size : Vector2 = Vector2(get_theme_constant("port_grab_distance_horizontal"), get_theme_constant("port_grab_distance_vertical")) - var port_pos : Vector2 = in_node.get_position() + in_node.get_connection_input_position(in_port) - port_size / 2 + var port_size: Vector2 = Vector2(get_theme_constant("port_grab_distance_horizontal"), get_theme_constant("port_grab_distance_vertical")) + var port_pos: Vector2 = in_node.get_position() + in_node.get_connection_input_position(in_port) - port_size / 2 var rect = Rect2(port_pos, port_size) return rect.has_point(mouse_position) @@ -750,8 +750,8 @@ Below is a sample code to help get started: :: func _is_in_output_hotzone(in_node, in_port, mouse_position): - var port_size : Vector2 = Vector2(get_theme_constant("port_grab_distance_horizontal"), get_theme_constant("port_grab_distance_vertical")) - var port_pos : Vector2 = in_node.get_position() + in_node.get_connection_output_position(in_port) - port_size / 2 + var port_size: Vector2 = Vector2(get_theme_constant("port_grab_distance_horizontal"), get_theme_constant("port_grab_distance_vertical")) + var port_pos: Vector2 = in_node.get_position() + in_node.get_connection_output_position(in_port) - port_size / 2 var rect = Rect2(port_pos, port_size) return rect.has_point(mouse_position) diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 784a50a297f..40e5af47b9c 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -146,7 +146,7 @@ Theme Properties +-----------------------------------+----------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`title_color` | ``Color(0.875, 0.875, 0.875, 1)`` | +-----------------------------------+----------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`close_h_offset` | ``22`` | + | :ref:`int` | :ref:`close_h_offset` | ``12`` | +-----------------------------------+----------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`close_offset` | ``22`` | +-----------------------------------+----------------------------------------------------------------------+-----------------------------------+ @@ -933,7 +933,7 @@ Color of the title text. .. rst-class:: classref-themeproperty -:ref:`int` **close_h_offset** = ``22`` +:ref:`int` **close_h_offset** = ``12`` .. container:: contribute diff --git a/classes/class_hmaccontext.rst b/classes/class_hmaccontext.rst index 0c33cf745b4..045fa308d6c 100644 --- a/classes/class_hmaccontext.rst +++ b/classes/class_hmaccontext.rst @@ -30,11 +30,11 @@ The HMACContext class is useful for advanced HMAC use cases, such as streaming t var ctx = HMACContext.new() func _ready(): - var key = "supersecret".to_utf8() + var key = "supersecret".to_utf8_buffer() var err = ctx.start(HashingContext.HASH_SHA256, key) assert(err == OK) - var msg1 = "this is ".to_utf8() - var msg2 = "super duper secret".to_utf8() + var msg1 = "this is ".to_utf8_buffer() + var msg2 = "super duper secret".to_utf8_buffer() err = ctx.update(msg1) assert(err == OK) err = ctx.update(msg2) @@ -54,11 +54,11 @@ The HMACContext class is useful for advanced HMAC use cases, such as streaming t public override void _Ready() { - byte[] key = "supersecret".ToUtf8(); + byte[] key = "supersecret".ToUtf8Buffer(); Error err = _ctx.Start(HashingContext.HashType.Sha256, key); Debug.Assert(err == Error.Ok); - byte[] msg1 = "this is ".ToUtf8(); - byte[] msg2 = "super duper secret".ToUtf8(); + byte[] msg1 = "this is ".ToUtf8Buffer(); + byte[] msg2 = "super duper secret".ToUtf8Buffer(); err = _ctx.Update(msg1); Debug.Assert(err == Error.Ok); err = _ctx.Update(msg2); diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index b1aa0be0236..b83747fc75e 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -31,6 +31,8 @@ Theme Properties .. table:: :widths: auto + +-----------------------------------+---------------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`center_grabber` | ``0`` | +-----------------------------------+---------------------------------------------------------------------------------+-------+ | :ref:`int` | :ref:`grabber_offset` | ``0`` | +-----------------------------------+---------------------------------------------------------------------------------+-------+ @@ -58,6 +60,18 @@ Theme Properties Theme Property Descriptions --------------------------- +.. _class_HSlider_theme_constant_center_grabber: + +.. rst-class:: classref-themeproperty + +:ref:`int` **center_grabber** = ``0`` + +Boolean constant. If ``1``, the grabber texture size will be ignored and it will fit within slider's bounds based only on its center position. + +.. rst-class:: classref-item-separator + +---- + .. _class_HSlider_theme_constant_grabber_offset: .. rst-class:: classref-themeproperty diff --git a/classes/class_image.rst b/classes/class_image.rst index bb85bd15085..6c1fab9cb1b 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -671,6 +671,22 @@ Use ETC2 compression. Use BPTC compression. +.. _class_Image_constant_COMPRESS_ASTC: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompressMode` **COMPRESS_ASTC** = ``4`` + +Use ASTC compression. + +.. _class_Image_constant_COMPRESS_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompressMode` **COMPRESS_MAX** = ``5`` + +Represents the size of the :ref:`CompressMode` enum. + .. rst-class:: classref-item-separator ---- @@ -934,7 +950,7 @@ Removes the image's mipmaps. 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. -The ``mode`` parameter helps to pick the best compression method for DXT and ETC2 formats. It is ignored for ASTC compression. +The ``source`` parameter helps to pick the best compression method for DXT and ETC2 formats. It is ignored for ASTC compression. For ASTC compression, the ``astc_format`` parameter must be supplied. diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 9b29941d1ab..98a191b19d4 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -43,7 +43,7 @@ This is because images have to be imported as a :ref:`CompressedTexture2D`. diff --git a/classes/class_immediatemesh.rst b/classes/class_immediatemesh.rst index 257eb286d7c..71cc344db4b 100644 --- a/classes/class_immediatemesh.rst +++ b/classes/class_immediatemesh.rst @@ -19,7 +19,35 @@ Mesh optimized for creating geometry manually. Description ----------- -Mesh optimized for creating geometry manually, similar to OpenGL1.x immediate mode. +A mesh type optimized for creating geometry manually, similar to OpenGL 1.x immediate mode. + +Here's a sample on how to generate a triangular face: + + +.. tabs:: + +var mesh = ImmediateMesh.new() + +mesh.surface_begin(Mesh.PRIMITIVE_TRIANGLES) + +mesh.surface_add_vertex(Vector3.LEFT) + +mesh.surface_add_vertex(Vector3.FORWARD) + +mesh.surface_add_vertex(Vector3.ZERO) + +mesh.surface_end() + + + +\ **Note:** Generating complex geometries with **ImmediateMesh** is highly inefficient. Instead, it is designed to generate simple geometry that changes often. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Using ImmediateMesh <../tutorials/3d/procedural_geometry/immediatemesh>` .. rst-class:: classref-reftable-group diff --git a/classes/class_input.rst b/classes/class_input.rst index 64a5bac9052..353ca436073 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -901,13 +901,13 @@ void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :r Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing ``null`` to the image parameter resets to the system cursor. See :ref:`CursorShape` for the list of shapes. -\ ``image``'s size must be lower than 256×256. +\ ``image``'s size must be lower than or equal to 256×256. To avoid rendering issues, sizes lower than or equal to 128×128 are recommended. \ ``hotspot`` must be within ``image``'s size. \ **Note:** :ref:`AnimatedTexture`\ s aren't supported as custom mouse cursors. If using an :ref:`AnimatedTexture`, only the first frame will be displayed. -\ **Note:** Only images imported with the **Lossless**, **Lossy** or **Uncompressed** compression modes are supported. The **Video RAM** compression mode can't be used for custom cursors. +\ **Note:** The **Lossless**, **Lossy** or **Uncompressed** compression modes are recommended. The **Video RAM** compression mode can be used, but it will be decompressed on the CPU, which means loading times are slowed down and no memory is saved compared to lossless modes. \ **Note:** On the web platform, the maximum allowed cursor image size is 128×128. Cursor images larger than 32×32 will also only be displayed if the mouse cursor image is entirely located within the page for `security reasons `__. diff --git a/classes/class_inputeventfromwindow.rst b/classes/class_inputeventfromwindow.rst index 9ae4dd5fc39..7065219ff08 100644 --- a/classes/class_inputeventfromwindow.rst +++ b/classes/class_inputeventfromwindow.rst @@ -14,9 +14,14 @@ InputEventFromWindow **Inherited By:** :ref:`InputEventScreenDrag`, :ref:`InputEventScreenTouch`, :ref:`InputEventWithModifiers` -.. container:: contribute +Base class for :ref:`Viewport`-based input events. - There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Description +----------- + +InputEventFromWindow represents events specifically received by windows. This includes mouse events, keyboard events in focused windows or touch screen actions. .. rst-class:: classref-reftable-group @@ -50,9 +55,7 @@ Property Descriptions - void **set_window_id** **(** :ref:`int` value **)** - :ref:`int` **get_window_id** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The ID of a :ref:`Window` that received this event. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index d66d668f6e0..ceb0aa276e5 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -16,6 +16,13 @@ InputEventGesture Base class for touch control gestures. +.. rst-class:: classref-introduction-group + +Description +----------- + +InputEventGesture is sent when a user performs a supported gesture on a touch screen. Gestures can't be emulated using mouse, because they typically require multi-touch. + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_inputeventmagnifygesture.rst b/classes/class_inputeventmagnifygesture.rst index 95d092cb125..cb93e7ae582 100644 --- a/classes/class_inputeventmagnifygesture.rst +++ b/classes/class_inputeventmagnifygesture.rst @@ -12,9 +12,14 @@ InputEventMagnifyGesture **Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEventFromWindow` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -.. container:: contribute +:ref:`InputEvent` that represents a magnifying touch gesture. - There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Description +----------- + +Magnify gesture is performed when the user pinches the touch screen. It's typically used for zooming. .. rst-class:: classref-reftable-group @@ -48,9 +53,7 @@ Property Descriptions - void **set_factor** **(** :ref:`float` value **)** - :ref:`float` **get_factor** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The amount (or delta) of the event. This value is higher the faster the gesture is performed. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst index 2b87cdc7b42..1c58524a15b 100644 --- a/classes/class_inputeventpangesture.rst +++ b/classes/class_inputeventpangesture.rst @@ -12,9 +12,14 @@ InputEventPanGesture **Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEventFromWindow` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -.. container:: contribute +:ref:`InputEvent` that represents a panning touch gesture. - There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Description +----------- + +Pan gesture is performed when the user swipes the touch screen with two fingers. It's typically used for panning/scrolling. .. rst-class:: classref-reftable-group @@ -48,9 +53,7 @@ Property Descriptions - void **set_delta** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_delta** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Panning amount since last pan event. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_inputeventshortcut.rst b/classes/class_inputeventshortcut.rst index cd043aa6afd..392c478b742 100644 --- a/classes/class_inputeventshortcut.rst +++ b/classes/class_inputeventshortcut.rst @@ -12,9 +12,14 @@ InputEventShortcut **Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -.. container:: contribute +:ref:`InputEvent` that signifies a triggered keyboard :ref:`Shortcut`. - There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Description +----------- + +InputEventShortcut is a special event that can be received in :ref:`Node._unhandled_key_input`. It's typically sent by the editor's Command Palette to trigger actions, but can also be sent manually using :ref:`Viewport.push_unhandled_input`. .. rst-class:: classref-reftable-group @@ -48,9 +53,7 @@ Property Descriptions - void **set_shortcut** **(** :ref:`Shortcut` value **)** - :ref:`Shortcut` **get_shortcut** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The :ref:`Shortcut` represented by this event. Its :ref:`Shortcut.matches_event` method will always return ``true`` for this event. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_int.rst b/classes/class_int.rst index b930c7f14c7..2dda122c1fa 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -10,51 +10,52 @@ int === -Integer built-in type. +Built-in integer Variant type. .. rst-class:: classref-introduction-group Description ----------- -Signed 64-bit integer type. +Signed 64-bit integer type. This means that it can take values from ``-2^63`` to ``2^63 - 1``, i.e. from ``-9223372036854775808`` to ``9223372036854775807``. When it exceeds these bounds, it will wrap around. -It can take values in the interval ``[-2^63, 2^63 - 1]``, i.e. ``[-9223372036854775808, 9223372036854775807]``. Exceeding those bounds will wrap around. +\ **int**\ s can be automatically converted to :ref:`float`\ s when necessary, for example when passing them as arguments in functions. The :ref:`float` will be as close to the original integer as possible. -\ **int** is a :ref:`Variant` type, and will thus be used when assigning an integer value to a :ref:`Variant`. It can also be enforced with the ``: int`` type hint. +Likewise, :ref:`float`\ s can be automatically converted into **int**\ s. This will truncate the :ref:`float`, discarding anything after the floating point. + +\ **Note:** In a boolean context, an **int** will evaluate to ``false`` if it equals ``0``, and to ``true`` otherwise. .. tabs:: .. code-tab:: gdscript - var my_variant = 0 # int, value 0. - my_variant += 4.2 # float, value 4.2. - var my_int: int = 1 # int, value 1. - my_int = 4.2 # int, value 4, the right value is implicitly cast to int. - my_int = int("6.7") # int, value 6, the String is explicitly cast with int. - var max_int = 9223372036854775807 - print(max_int) # 9223372036854775807, OK. - max_int += 1 - print(max_int) # -9223372036854775808, we overflowed and wrapped around. + var x: int = 1 # x is 1 + x = 4.2 # x is 4, because 4.2 gets truncated + var max_int = 9223372036854775807 # Biggest value an int can store + max_int += 1 # max_int is -9223372036854775808, because it wrapped around .. code-tab:: csharp - int myInt = (int)"6.7".ToFloat(); // int, value 6, the String is explicitly cast with int. - // We have to use `long` here, because GDSript's `int` - // is 64 bits long while C#'s `int` is only 32 bits. - long maxInt = 9223372036854775807; - GD.Print(maxInt); // 9223372036854775807, OK. - maxInt++; - GD.Print(maxInt); // -9223372036854775808, we overflowed and wrapped around. + int x = 1; // x is 1 + x = 4.2; // x is 4, because 4.2 gets truncated + // We use long below, because GDScript's int is 64-bit while C#'s int is 32-bit. + long maxLong = 9223372036854775807; // Biggest value a long can store + maxLong++; // maxLong is now -9223372036854775808, because it wrapped around. - // Alternatively, if we used C#'s 32-bit `int` type, the maximum value is much smaller: - int halfInt = 2147483647; - GD.Print(halfInt); // 2147483647, OK. - halfInt++; - GD.Print(halfInt); // -2147483648, we overflowed and wrapped around. + // Alternatively with C#'s 32-bit int type, which has a smaller maximum value. + int maxInt = 2147483647; // Biggest value an int can store + maxInt++; // maxInt is now -2147483648, because it wrapped around + + +In GDScript, you can use the ``0b`` literal for binary representation, the ``0x`` literal for hexadecimal representation, and the ``_`` symbol to separate long numbers and improve readability. + +:: + var x = 0b1001 # x is 9 + var y = 0xF5 # y is 245 + var z = 10_000_000 # z is 10000000 .. rst-class:: classref-reftable-group @@ -179,7 +180,7 @@ Constructor Descriptions :ref:`int` **int** **(** **)** -Constructs a default-initialized **int** set to ``0``. +Constructs an **int** set to ``0``. .. rst-class:: classref-item-separator @@ -199,7 +200,7 @@ Constructs an **int** as a copy of the given **int**. :ref:`int` **int** **(** :ref:`String` from **)** -Converts a :ref:`String` to an **int**, following the same rules as :ref:`String.to_int`. +Constructs a new **int** from a :ref:`String`, following the same rules as :ref:`String.to_int`. .. rst-class:: classref-item-separator @@ -209,7 +210,7 @@ Converts a :ref:`String` to an **int**, following the same rules a :ref:`int` **int** **(** :ref:`bool` from **)** -Cast a :ref:`bool` value to an integer value, ``int(true)`` will be equals to 1 and ``int(false)`` will be equals to 0. +Constructs a new **int** from a :ref:`bool`. ``true`` is converted to ``1`` and ``false`` is converted to ``0``. .. rst-class:: classref-item-separator @@ -219,7 +220,7 @@ Cast a :ref:`bool` value to an integer value, ``int(true)`` will be :ref:`int` **int** **(** :ref:`float` from **)** -Cast a float value to an integer value, this method simply removes the number fractions (i.e. rounds ``from`` towards zero), so for example ``int(2.7)`` will be equals to 2, ``int(0.1)`` will be equals to 0 and ``int(-2.7)`` will be equals to -2. This operation is also called truncation. +Constructs a new **int** from a :ref:`float`. This will truncate the :ref:`float`, discarding anything after the floating point. .. rst-class:: classref-section-separator @@ -236,7 +237,7 @@ Operator Descriptions :ref:`bool` **operator !=** **(** :ref:`float` right **)** -Returns ``true`` if this **int** is not equivalent to the given :ref:`float`. +Returns ``true`` if the **int** is not equivalent to the :ref:`float`. .. rst-class:: classref-item-separator @@ -248,7 +249,7 @@ Returns ``true`` if this **int** is not equivalent to the given :ref:`float` **operator !=** **(** :ref:`int` right **)** -Returns ``true`` if the integers are not equal. +Returns ``true`` if the **int**\ s are not equal. .. rst-class:: classref-item-separator @@ -260,13 +261,13 @@ Returns ``true`` if the integers are not equal. :ref:`int` **operator %** **(** :ref:`int` right **)** -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 :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. +Returns the remainder after dividing two **int**\ s. Uses truncated division, which returns a negative number if the dividend is negative. If this is not desired, consider using :ref:`@GlobalScope.posmod`. :: - print(5 % 2) # 1 - print(12 % 4) # 0 - print(-5 % 3) # -2 + print(6 % 2) # Prints 0 + print(11 % 4) # Prints 3 + print(-5 % 3) # Prints -2 .. rst-class:: classref-item-separator @@ -278,21 +279,20 @@ Returns the remainder after dividing two integers. This operation uses truncated :ref:`int` **operator &** **(** :ref:`int` right **)** -Returns the result of bitwise ``AND`` operation for two integers. +Performs the bitwise ``AND`` operation. :: - print(3 & 1) # 1 - print(11 & 3) # 3 + print(0b1100 & 0b1010) # Prints 8 (binary 1000) -It's useful to retrieve binary flags from a variable. +This is useful for retrieving binary flags from a variable. :: - var flags = 5 - # Do something if the first bit is enabled. - if flags & 1: - do_stuff() + var flags = 0b101 + # Check if the first or second bit are enabled. + if flags & 0b011: + do_stuff() # This line will run. .. rst-class:: classref-item-separator @@ -304,7 +304,7 @@ It's useful to retrieve binary flags from a variable. :ref:`Color` **operator *** **(** :ref:`Color` right **)** -Multiplies each component of the :ref:`Color` by the given **int**. +Multiplies each component of the :ref:`Color` by the **int**. .. rst-class:: classref-item-separator @@ -316,7 +316,7 @@ Multiplies each component of the :ref:`Color` by the given **int**. :ref:`Quaternion` **operator *** **(** :ref:`Quaternion` right **)** -Multiplies each component of the :ref:`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 :ref:`Quaternion` by the **int**. This operation is not meaningful on its own, but it can be used as a part of a larger expression. .. rst-class:: classref-item-separator @@ -328,11 +328,11 @@ Multiplies each component of the :ref:`Quaternion` by the give :ref:`Vector2` **operator *** **(** :ref:`Vector2` right **)** -Multiplies each component of the :ref:`Vector2` by the given **int**. +Multiplies each component of the :ref:`Vector2` by the **int**. :: - print(2 * Vector2(1, 1)) # Vector2(2, 2) + print(2 * Vector2(1, 4)) # Prints (2, 8) .. rst-class:: classref-item-separator @@ -344,7 +344,7 @@ Multiplies each component of the :ref:`Vector2` by the given **in :ref:`Vector2i` **operator *** **(** :ref:`Vector2i` right **)** -Multiplies each component of the :ref:`Vector2i` by the given **int**. +Multiplies each component of the :ref:`Vector2i` by the **int**. .. rst-class:: classref-item-separator @@ -356,7 +356,7 @@ Multiplies each component of the :ref:`Vector2i` by the given ** :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** -Multiplies each component of the :ref:`Vector3` by the given **int**. +Multiplies each component of the :ref:`Vector3` by the **int**. .. rst-class:: classref-item-separator @@ -368,7 +368,7 @@ Multiplies each component of the :ref:`Vector3` by the given **in :ref:`Vector3i` **operator *** **(** :ref:`Vector3i` right **)** -Multiplies each component of the :ref:`Vector3i` by the given **int**. +Multiplies each component of the :ref:`Vector3i` by the **int**. .. rst-class:: classref-item-separator @@ -380,7 +380,7 @@ Multiplies each component of the :ref:`Vector3i` by the given ** :ref:`Vector4` **operator *** **(** :ref:`Vector4` right **)** -Multiplies each component of the :ref:`Vector4` by the given **int**. +Multiplies each component of the :ref:`Vector4` by the **int**. .. rst-class:: classref-item-separator @@ -392,7 +392,7 @@ Multiplies each component of the :ref:`Vector4` by the given **in :ref:`Vector4i` **operator *** **(** :ref:`Vector4i` right **)** -Multiplies each component of the :ref:`Vector4i` by the given **int**. +Multiplies each component of the :ref:`Vector4i` by the **int**. .. rst-class:: classref-item-separator @@ -404,7 +404,7 @@ Multiplies each component of the :ref:`Vector4i` by the given ** :ref:`float` **operator *** **(** :ref:`float` right **)** -Multiplies an **int** and a :ref:`float`. The result is a :ref:`float`. +Multiplies the :ref:`float` by the **int**. The result is a :ref:`float`. .. rst-class:: classref-item-separator @@ -416,7 +416,7 @@ Multiplies an **int** and a :ref:`float`. The result is a :ref:`flo :ref:`int` **operator *** **(** :ref:`int` right **)** -Multiplies two **int**\ s. +Multiplies the two **int**\ s. .. rst-class:: classref-item-separator @@ -432,7 +432,7 @@ Raises an **int** to a power of a :ref:`float`. The result is a :re :: - print(8**0.25) # 1.68179283050743 + print(2 ** 0.5) # Prints 1.4142135623731 .. rst-class:: classref-item-separator @@ -444,11 +444,11 @@ Raises an **int** to a power of a :ref:`float`. The result is a :re :ref:`int` **operator **** **(** :ref:`int` right **)** -Raises an **int** to a power of a **int**. +Raises the left **int** to a power of the right **int**. :: - print(5**5) # 3125 + print(3 ** 4) # Prints 81 .. rst-class:: classref-item-separator @@ -460,7 +460,7 @@ Raises an **int** to a power of a **int**. :ref:`float` **operator +** **(** :ref:`float` right **)** -Adds an **int** and a :ref:`float`. The result is a :ref:`float`. +Adds the **int** and the :ref:`float`. The result is a :ref:`float`. .. rst-class:: classref-item-separator @@ -472,7 +472,7 @@ Adds an **int** and a :ref:`float`. The result is a :ref:`float` **operator +** **(** :ref:`int` right **)** -Adds two integers. +Adds the two **int**\ s. .. rst-class:: classref-item-separator @@ -484,7 +484,7 @@ Adds two integers. :ref:`float` **operator -** **(** :ref:`float` right **)** -Subtracts a :ref:`float` from an **int**. The result is a :ref:`float`. +Subtracts the :ref:`float` from the **int**. The result is a :ref:`float`. .. rst-class:: classref-item-separator @@ -496,7 +496,7 @@ Subtracts a :ref:`float` from an **int**. The result is a :ref:`flo :ref:`int` **operator -** **(** :ref:`int` right **)** -Subtracts two integers. +Subtracts the two **int**\ s. .. rst-class:: classref-item-separator @@ -508,11 +508,11 @@ Subtracts two integers. :ref:`float` **operator /** **(** :ref:`float` right **)** -Divides an **int** by a :ref:`float`. The result is a :ref:`float`. +Divides the **int** by the :ref:`float`. The result is a :ref:`float`. :: - print(10 / 3.0) # 3.333... + print(10 / 3.0) # Prints 3.33333333333333 .. rst-class:: classref-item-separator @@ -524,12 +524,12 @@ Divides an **int** by a :ref:`float`. The result is a :ref:`float` **operator /** **(** :ref:`int` right **)** -Divides two integers. The decimal part of the result is discarded (truncated). +Divides the two **int**\ s. The result is an **int**. This will truncate the :ref:`float`, discarding anything after the floating point. :: - print(10 / 2) # 5 - print(10 / 3) # 3 + print(6 / 2) # Prints 3 + print(5 / 3) # Prints 1 .. rst-class:: classref-item-separator @@ -541,7 +541,7 @@ Divides two integers. The decimal part of the result is discarded (truncated). :ref:`bool` **operator <** **(** :ref:`float` right **)** -Returns ``true`` if this **int** is less than the given :ref:`float`. +Returns ``true`` if the **int** is less than the :ref:`float`. .. rst-class:: classref-item-separator @@ -553,7 +553,7 @@ Returns ``true`` if this **int** is less than the given :ref:`float :ref:`bool` **operator <** **(** :ref:`int` right **)** -Returns ``true`` if the left integer is less than the right one. +Returns ``true`` if the left **int** is less than the right **int**. .. rst-class:: classref-item-separator @@ -565,12 +565,12 @@ Returns ``true`` if the left integer is less than the right one. :ref:`int` **operator <<** **(** :ref:`int` right **)** -Performs bitwise shift left operation on the integer. Effectively the same as multiplying by a power of 2. +Performs the bitwise shift left operation. Effectively the same as multiplying by a power of 2. :: - print(10 << 1) # 20 - print(10 << 4) # 160 + print(0b1010 << 1) # Prints 20 (binary 10100) + print(0b1010 << 3) # Prints 80 (binary 1010000) .. rst-class:: classref-item-separator @@ -582,7 +582,7 @@ Performs bitwise shift left operation on the integer. Effectively the same as mu :ref:`bool` **operator <=** **(** :ref:`float` right **)** -Returns ``true`` if this **int** is less than or equal to the given :ref:`float`. +Returns ``true`` if the **int** is less than or equal to the :ref:`float`. .. rst-class:: classref-item-separator @@ -594,7 +594,7 @@ Returns ``true`` if this **int** is less than or equal to the given :ref:`float< :ref:`bool` **operator <=** **(** :ref:`int` right **)** -Returns ``true`` if the left integer is less than or equal to the right one. +Returns ``true`` if the left **int** is less than or equal to the right **int**. .. rst-class:: classref-item-separator @@ -606,7 +606,7 @@ Returns ``true`` if the left integer is less than or equal to the right one. :ref:`bool` **operator ==** **(** :ref:`float` right **)** -Returns ``true`` if the integer is equal to the given :ref:`float`. +Returns ``true`` if the **int** is equal to the :ref:`float`. .. rst-class:: classref-item-separator @@ -618,7 +618,7 @@ Returns ``true`` if the integer is equal to the given :ref:`float`. :ref:`bool` **operator ==** **(** :ref:`int` right **)** -Returns ``true`` if both integers are equal. +Returns ``true`` if the two **int**\ s are equal. .. rst-class:: classref-item-separator @@ -630,7 +630,7 @@ Returns ``true`` if both integers are equal. :ref:`bool` **operator >** **(** :ref:`float` right **)** -Returns ``true`` if this **int** is greater than the given :ref:`float`. +Returns ``true`` if the **int** is greater than the :ref:`float`. .. rst-class:: classref-item-separator @@ -642,7 +642,7 @@ Returns ``true`` if this **int** is greater than the given :ref:`float` **operator >** **(** :ref:`int` right **)** -Returns ``true`` if the left integer is greater than the right one. +Returns ``true`` if the left **int** is greater than the right **int**. .. rst-class:: classref-item-separator @@ -654,7 +654,7 @@ Returns ``true`` if the left integer is greater than the right one. :ref:`bool` **operator >=** **(** :ref:`float` right **)** -Returns ``true`` if this **int** is greater than or equal to the given :ref:`float`. +Returns ``true`` if the **int** is greater than or equal to the :ref:`float`. .. rst-class:: classref-item-separator @@ -666,7 +666,7 @@ Returns ``true`` if this **int** is greater than or equal to the given :ref:`flo :ref:`bool` **operator >=** **(** :ref:`int` right **)** -Returns ``true`` if the left integer is greater than or equal to the right one. +Returns ``true`` if the left **int** is greater than or equal to the right **int**. .. rst-class:: classref-item-separator @@ -678,12 +678,12 @@ Returns ``true`` if the left integer is greater than or equal to the right one. :ref:`int` **operator >>** **(** :ref:`int` right **)** -Performs bitwise shift right operation on the integer. Effectively the same as dividing by a power of 2. +Performs the bitwise shift right operation. Effectively the same as dividing by a power of 2. :: - print(10 >> 1) # 5 - print(10 >> 2) # 2 + print(0b1010 >> 1) # Prints 5 (binary 101) + print(0b1010 >> 2) # Prints 2 (binary 10) .. rst-class:: classref-item-separator @@ -695,12 +695,11 @@ Performs bitwise shift right operation on the integer. Effectively the same as d :ref:`int` **operator ^** **(** :ref:`int` right **)** -Returns the result of bitwise ``XOR`` operation for two integers. +Performs the bitwise ``XOR`` operation. :: - print(5 ^ 1) # 4 - print(4 ^ 7) # 3 + print(0b1100 ^ 0b1010) # Prints 6 (binary 110) .. rst-class:: classref-item-separator @@ -736,21 +735,18 @@ Returns the negated value of the **int**. If positive, turns the number negative :ref:`int` **operator |** **(** :ref:`int` right **)** -Returns the result of bitwise ``OR`` operation for two integers. +Performs the bitwise ``OR`` operation. :: - print(2 | 4) # 6 - print(1 | 3) # 3 + print(0b1100 | 0b1010) # Prints 14 (binary 1110) -It's useful to store binary flags in a variable. +This is useful for storing binary flags in a variable. :: var flags = 0 - # Turn first and third bit on. - flags |= 1 - flags |= 4 + flags |= 0b101 # Turn the first and third bits on. .. rst-class:: classref-item-separator @@ -762,12 +758,12 @@ It's useful to store binary flags in a variable. :ref:`int` **operator ~** **(** **)** -Returns the result of bitwise ``NOT`` operation for the integer. It's effectively equal to ``-int + 1``. +Performs the bitwise ``NOT`` operation on the **int**. Due to `2's complement `__, it's effectively equal to ``-(int + 1)``. :: - print(~4) # -3 - print(~7) # -6 + print(~4) # Prints -5 + print(~(-7)) # Prints 6 .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 0d5263dc8ed..b1f79fd6d50 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -42,6 +42,8 @@ Properties +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`allow_rmb_select` | ``false`` | +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`allow_search` | ``true`` | + +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`auto_height` | ``false`` | +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | @@ -176,6 +178,8 @@ Theme Properties +---------------------------------+----------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_color` | ``Color(0.65, 0.65, 0.65, 1)`` | +---------------------------------+----------------------------------------------------------------------------+--------------------------------+ + | :ref:`Color` | :ref:`font_hovered_color` | ``Color(0.95, 0.95, 0.95, 1)`` | + +---------------------------------+----------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | +---------------------------------+----------------------------------------------------------------------------+--------------------------------+ | :ref:`Color` | :ref:`font_selected_color` | ``Color(1, 1, 1, 1)`` | @@ -202,6 +206,8 @@ Theme Properties +---------------------------------+----------------------------------------------------------------------------+--------------------------------+ | :ref:`StyleBox` | :ref:`focus` | | +---------------------------------+----------------------------------------------------------------------------+--------------------------------+ + | :ref:`StyleBox` | :ref:`hovered` | | + +---------------------------------+----------------------------------------------------------------------------+--------------------------------+ | :ref:`StyleBox` | :ref:`panel` | | +---------------------------------+----------------------------------------------------------------------------+--------------------------------+ | :ref:`StyleBox` | :ref:`selected` | | @@ -378,6 +384,23 @@ If ``true``, right mouse button click can select items. ---- +.. _class_ItemList_property_allow_search: + +.. rst-class:: classref-property + +:ref:`bool` **allow_search** = ``true`` + +.. rst-class:: classref-property-setget + +- void **set_allow_search** **(** :ref:`bool` value **)** +- :ref:`bool` **get_allow_search** **(** **)** + +If ``true``, allows navigating the **ItemList** with letter keys through incremental search. + +.. rst-class:: classref-item-separator + +---- + .. _class_ItemList_property_auto_height: .. rst-class:: classref-property @@ -1127,6 +1150,18 @@ Default text :ref:`Color` of the item. ---- +.. _class_ItemList_theme_color_font_hovered_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **font_hovered_color** = ``Color(0.95, 0.95, 0.95, 1)`` + +Text :ref:`Color` used when the item is hovered and not selected yet. + +.. rst-class:: classref-item-separator + +---- + .. _class_ItemList_theme_color_font_outline_color: .. rst-class:: classref-themeproperty @@ -1285,6 +1320,18 @@ The focused style for the **ItemList**, drawn on top of the background, but belo ---- +.. _class_ItemList_theme_style_hovered: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **hovered** + +:ref:`StyleBox` for the hovered, but not selected items. + +.. rst-class:: classref-item-separator + +---- + .. _class_ItemList_theme_style_panel: .. rst-class:: classref-themeproperty diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 2691cedd5bc..3974d0e48b7 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -158,6 +158,8 @@ Methods +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_scroll_offset` **(** **)** |const| | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_selected_text` **(** **)** | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selection_from_column` **(** **)** |const| | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selection_to_column` **(** **)** |const| | @@ -640,7 +642,7 @@ Text alignment as defined in the :ref:`HorizontalAlignment` value **)** - :ref:`bool` **is_caret_blink_enabled** **(** **)** -If ``true``, the caret (text cursor) blinks. +If ``true``, makes the caret blink. .. rst-class:: classref-item-separator @@ -657,7 +659,7 @@ If ``true``, the caret (text cursor) blinks. - void **set_caret_blink_interval** **(** :ref:`float` value **)** - :ref:`float` **get_caret_blink_interval** **(** **)** -Duration (in seconds) of a caret's blinking cycle. +The interval at which the caret blinks (in seconds). .. rst-class:: classref-item-separator @@ -727,7 +729,7 @@ Allow moving caret, selecting and removing the individual composite character co - void **set_clear_button_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_clear_button_enabled** **(** **)** -If ``true``, the **LineEdit** will show a clear button if ``text`` is not empty, which can be used to clear the text quickly. +If ``true``, the **LineEdit** will show a clear button if :ref:`text` is not empty, which can be used to clear the text quickly. .. rst-class:: classref-item-separator @@ -1264,6 +1266,18 @@ Returns the scroll offset due to :ref:`caret_column` **get_selected_text** **(** **)** + +Returns the text inside the selection. + +.. rst-class:: classref-item-separator + +---- + .. _class_LineEdit_method_get_selection_from_column: .. rst-class:: classref-method @@ -1572,7 +1586,7 @@ Texture for the clear button. See :ref:`clear_button_enabled` **focus** -Background used when **LineEdit** has GUI focus. The ``focus`` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. +Background used when **LineEdit** has GUI focus. The :ref:`focus` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. .. rst-class:: classref-item-separator diff --git a/classes/class_marker2d.rst b/classes/class_marker2d.rst index 5493212261d..035a24258f9 100644 --- a/classes/class_marker2d.rst +++ b/classes/class_marker2d.rst @@ -19,7 +19,7 @@ Generic 2D position hint for editing. Description ----------- -Generic 2D position hint for editing. It's just like a plain :ref:`Node2D`, but it displays as a cross in the 2D editor at all times. You can set cross' visual size by using the gizmo in the 2D editor while the node is selected. +Generic 2D position hint for editing. It's just like a plain :ref:`Node2D`, but it displays as a cross in the 2D editor at all times. You can set the cross' visual size by using the gizmo in the 2D editor while the node is selected. .. rst-class:: classref-reftable-group diff --git a/classes/class_meshconvexdecompositionsettings.rst b/classes/class_meshconvexdecompositionsettings.rst new file mode 100644 index 00000000000..e599c209dc3 --- /dev/null +++ b/classes/class_meshconvexdecompositionsettings.rst @@ -0,0 +1,322 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshConvexDecompositionSettings.xml. + +.. _class_MeshConvexDecompositionSettings: + +MeshConvexDecompositionSettings +=============================== + +**Inherits:** :ref:`RefCounted` **<** :ref:`Object` + +Parameters to be used with a :ref:`Mesh` convex decomposition operation. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Parameters to be used with a :ref:`Mesh` convex decomposition operation. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + | :ref:`bool` | :ref:`convex_hull_approximation` | ``true`` | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + | :ref:`int` | :ref:`convex_hull_downsampling` | ``4`` | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + | :ref:`float` | :ref:`max_concavity` | ``1.0`` | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + | :ref:`int` | :ref:`max_convex_hulls` | ``1`` | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + | :ref:`int` | :ref:`max_num_vertices_per_convex_hull` | ``32`` | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + | :ref:`float` | :ref:`min_volume_per_convex_hull` | ``0.0001`` | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + | :ref:`Mode` | :ref:`mode` | ``0`` | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + | :ref:`bool` | :ref:`normalize_mesh` | ``false`` | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + | :ref:`int` | :ref:`plane_downsampling` | ``4`` | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + | :ref:`bool` | :ref:`project_hull_vertices` | ``true`` | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + | :ref:`int` | :ref:`resolution` | ``10000`` | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + | :ref:`float` | :ref:`revolution_axes_clipping_bias` | ``0.05`` | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + | :ref:`float` | :ref:`symmetry_planes_clipping_bias` | ``0.05`` | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_MeshConvexDecompositionSettings_Mode: + +.. rst-class:: classref-enumeration + +enum **Mode**: + +.. _class_MeshConvexDecompositionSettings_constant_CONVEX_DECOMPOSITION_MODE_VOXEL: + +.. rst-class:: classref-enumeration-constant + +:ref:`Mode` **CONVEX_DECOMPOSITION_MODE_VOXEL** = ``0`` + +Constant for voxel-based approximate convex decomposition. + +.. _class_MeshConvexDecompositionSettings_constant_CONVEX_DECOMPOSITION_MODE_TETRAHEDRON: + +.. rst-class:: classref-enumeration-constant + +:ref:`Mode` **CONVEX_DECOMPOSITION_MODE_TETRAHEDRON** = ``1`` + +Constant for tetrahedron-based approximate convex decomposition. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_MeshConvexDecompositionSettings_property_convex_hull_approximation: + +.. rst-class:: classref-property + +:ref:`bool` **convex_hull_approximation** = ``true`` + +.. rst-class:: classref-property-setget + +- void **set_convex_hull_approximation** **(** :ref:`bool` value **)** +- :ref:`bool` **get_convex_hull_approximation** **(** **)** + +If enabled uses approximation for computing convex hulls. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MeshConvexDecompositionSettings_property_convex_hull_downsampling: + +.. rst-class:: classref-property + +:ref:`int` **convex_hull_downsampling** = ``4`` + +.. rst-class:: classref-property-setget + +- void **set_convex_hull_downsampling** **(** :ref:`int` value **)** +- :ref:`int` **get_convex_hull_downsampling** **(** **)** + +Controls the precision of the convex-hull generation process during the clipping plane selection stage. Ranges from ``1`` to ``16``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MeshConvexDecompositionSettings_property_max_concavity: + +.. rst-class:: classref-property + +:ref:`float` **max_concavity** = ``1.0`` + +.. rst-class:: classref-property-setget + +- void **set_max_concavity** **(** :ref:`float` value **)** +- :ref:`float` **get_max_concavity** **(** **)** + +Maximum concavity. Ranges from ``0.0`` to ``1.0``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MeshConvexDecompositionSettings_property_max_convex_hulls: + +.. rst-class:: classref-property + +:ref:`int` **max_convex_hulls** = ``1`` + +.. rst-class:: classref-property-setget + +- void **set_max_convex_hulls** **(** :ref:`int` value **)** +- :ref:`int` **get_max_convex_hulls** **(** **)** + +The maximum number of convex hulls to produce from the merge operation. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MeshConvexDecompositionSettings_property_max_num_vertices_per_convex_hull: + +.. rst-class:: classref-property + +:ref:`int` **max_num_vertices_per_convex_hull** = ``32`` + +.. rst-class:: classref-property-setget + +- void **set_max_num_vertices_per_convex_hull** **(** :ref:`int` value **)** +- :ref:`int` **get_max_num_vertices_per_convex_hull** **(** **)** + +Controls the maximum number of triangles per convex-hull. Ranges from ``4`` to ``1024``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MeshConvexDecompositionSettings_property_min_volume_per_convex_hull: + +.. rst-class:: classref-property + +:ref:`float` **min_volume_per_convex_hull** = ``0.0001`` + +.. rst-class:: classref-property-setget + +- void **set_min_volume_per_convex_hull** **(** :ref:`float` value **)** +- :ref:`float` **get_min_volume_per_convex_hull** **(** **)** + +Controls the adaptive sampling of the generated convex-hulls. Ranges from ``0.0`` to ``0.01``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MeshConvexDecompositionSettings_property_mode: + +.. rst-class:: classref-property + +:ref:`Mode` **mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_mode** **(** :ref:`Mode` value **)** +- :ref:`Mode` **get_mode** **(** **)** + +Mode for the approximate convex decomposition. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MeshConvexDecompositionSettings_property_normalize_mesh: + +.. rst-class:: classref-property + +:ref:`bool` **normalize_mesh** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_normalize_mesh** **(** :ref:`bool` value **)** +- :ref:`bool` **get_normalize_mesh** **(** **)** + +If enabled normalizes the mesh before applying the convex decomposition. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MeshConvexDecompositionSettings_property_plane_downsampling: + +.. rst-class:: classref-property + +:ref:`int` **plane_downsampling** = ``4`` + +.. rst-class:: classref-property-setget + +- void **set_plane_downsampling** **(** :ref:`int` value **)** +- :ref:`int` **get_plane_downsampling** **(** **)** + +Controls the granularity of the search for the "best" clipping plane. Ranges from ``1`` to ``16``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MeshConvexDecompositionSettings_property_project_hull_vertices: + +.. rst-class:: classref-property + +:ref:`bool` **project_hull_vertices** = ``true`` + +.. rst-class:: classref-property-setget + +- void **set_project_hull_vertices** **(** :ref:`bool` value **)** +- :ref:`bool` **get_project_hull_vertices** **(** **)** + +If enabled projects output convex hull vertices onto original source mesh to increase floating point accuracy of the results. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MeshConvexDecompositionSettings_property_resolution: + +.. rst-class:: classref-property + +:ref:`int` **resolution** = ``10000`` + +.. rst-class:: classref-property-setget + +- void **set_resolution** **(** :ref:`int` value **)** +- :ref:`int` **get_resolution** **(** **)** + +Maximum number of voxels generated during the voxelization stage. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MeshConvexDecompositionSettings_property_revolution_axes_clipping_bias: + +.. rst-class:: classref-property + +:ref:`float` **revolution_axes_clipping_bias** = ``0.05`` + +.. rst-class:: classref-property-setget + +- void **set_revolution_axes_clipping_bias** **(** :ref:`float` value **)** +- :ref:`float` **get_revolution_axes_clipping_bias** **(** **)** + +Controls the bias toward clipping along revolution axes. Ranges from ``0.0`` to ``1.0``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MeshConvexDecompositionSettings_property_symmetry_planes_clipping_bias: + +.. rst-class:: classref-property + +:ref:`float` **symmetry_planes_clipping_bias** = ``0.05`` + +.. rst-class:: classref-property-setget + +- void **set_symmetry_planes_clipping_bias** **(** :ref:`float` value **)** +- :ref:`float` **get_symmetry_planes_clipping_bias** **(** **)** + +Controls the bias toward clipping along symmetry planes. Ranges from ``0.0`` to ``1.0``. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index 778e5b1b291..6d2c6e27c9f 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -40,7 +40,7 @@ Below is an example of how MeshDataTool may be used. vertex += mdt.get_vertex_normal(i) # Save your change. mdt.set_vertex(i, vertex) - mesh.surface_remove(0) + mesh.clear_surfaces() mdt.commit_to_surface(mesh) var mi = MeshInstance.new() mi.mesh = mesh @@ -60,7 +60,7 @@ Below is an example of how MeshDataTool may be used. // Save your change. mdt.SetVertex(i, vertex); } - mesh.SurfaceRemove(0); + mesh.ClearSurfaces(); mdt.CommitToSurface(mesh); var mi = new MeshInstance(); mi.Mesh = mesh; diff --git a/classes/class_meshinstance3d.rst b/classes/class_meshinstance3d.rst index 2d674074498..58d503f1f88 100644 --- a/classes/class_meshinstance3d.rst +++ b/classes/class_meshinstance3d.rst @@ -60,31 +60,31 @@ Methods .. table:: :widths: auto - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_convex_collision` **(** :ref:`bool` clean=true, :ref:`bool` simplify=false **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_debug_tangents` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_multiple_convex_collisions` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_trimesh_collision` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find_blend_shape_by_name` **(** :ref:`StringName` name **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Material` | :ref:`get_active_material` **(** :ref:`int` surface **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_blend_shape_count` **(** **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_blend_shape_value` **(** :ref:`int` blend_shape_idx **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Material` | :ref:`get_surface_override_material` **(** :ref:`int` surface **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_surface_override_material_count` **(** **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_blend_shape_value` **(** :ref:`int` blend_shape_idx, :ref:`float` value **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_surface_override_material` **(** :ref:`int` surface, :ref:`Material` material **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`create_convex_collision` **(** :ref:`bool` clean=true, :ref:`bool` simplify=false **)** | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`create_debug_tangents` **(** **)** | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`create_multiple_convex_collisions` **(** :ref:`MeshConvexDecompositionSettings` settings=null **)** | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`create_trimesh_collision` **(** **)** | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find_blend_shape_by_name` **(** :ref:`StringName` name **)** | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Material` | :ref:`get_active_material` **(** :ref:`int` surface **)** |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_blend_shape_count` **(** **)** |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_blend_shape_value` **(** :ref:`int` blend_shape_idx **)** |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Material` | :ref:`get_surface_override_material` **(** :ref:`int` surface **)** |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_surface_override_material_count` **(** **)** |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_blend_shape_value` **(** :ref:`int` blend_shape_idx, :ref:`float` value **)** | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_surface_override_material` **(** :ref:`int` surface, :ref:`Material` material **)** | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -183,9 +183,9 @@ This helper creates a **MeshInstance3D** child node with gizmos at every vertex .. rst-class:: classref-method -void **create_multiple_convex_collisions** **(** **)** +void **create_multiple_convex_collisions** **(** :ref:`MeshConvexDecompositionSettings` settings=null **)** -This helper creates a :ref:`StaticBody3D` child node with multiple :ref:`ConvexPolygonShape3D` collision shapes calculated from the mesh geometry via convex decomposition. It's mainly used for testing. +This helper creates a :ref:`StaticBody3D` child node with multiple :ref:`ConvexPolygonShape3D` collision shapes calculated from the mesh geometry via convex decomposition. The convex decomposition operation can be controlled with parameters from the optional ``settings``. .. rst-class:: classref-item-separator diff --git a/classes/class_multiplayerpeerextension.rst b/classes/class_multiplayerpeerextension.rst index 8da8e70399e..9aa48ea6f95 100644 --- a/classes/class_multiplayerpeerextension.rst +++ b/classes/class_multiplayerpeerextension.rst @@ -42,6 +42,10 @@ Methods +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_get_packet` **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_packet_channel` **(** **)** |virtual| |const| | + +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TransferMode` | :ref:`_get_packet_mode` **(** **)** |virtual| |const| | + +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_packet_peer` **(** **)** |virtual| |const| | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`_get_packet_script` **(** **)** |virtual| | @@ -56,6 +60,8 @@ Methods +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_server` **(** **)** |virtual| |const| | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_server_relay_supported` **(** **)** |virtual| |const| | + +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_poll` **(** **)** |virtual| | +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_put_packet` **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| | @@ -152,6 +158,30 @@ Called when a packet needs to be received by the :ref:`MultiplayerAPI` **_get_packet_channel** **(** **)** |virtual| |const| + +Called to get the channel over which the next available packet was received. See :ref:`MultiplayerPeer.get_packet_channel`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MultiplayerPeerExtension_method__get_packet_mode: + +.. rst-class:: classref-method + +:ref:`TransferMode` **_get_packet_mode** **(** **)** |virtual| |const| + +Called to get the :ref:`TransferMode` the remote peer used to send the next available packet. See :ref:`MultiplayerPeer.get_packet_mode`. + +.. rst-class:: classref-item-separator + +---- + .. _class_MultiplayerPeerExtension_method__get_packet_peer: .. rst-class:: classref-method @@ -206,7 +236,7 @@ Called when the transfer mode to use is read on this :ref:`MultiplayerPeer` **_get_unique_id** **(** **)** |virtual| |const| -Called when the unique ID of this :ref:`MultiplayerPeer` is requested (see :ref:`MultiplayerPeer.get_unique_id`). +Called when the unique ID of this :ref:`MultiplayerPeer` is requested (see :ref:`MultiplayerPeer.get_unique_id`). The value must be between ``1`` and ``2147483647``. .. rst-class:: classref-item-separator @@ -236,6 +266,18 @@ Called when the "is server" status is requested on the :ref:`MultiplayerAPI` **_is_server_relay_supported** **(** **)** |virtual| |const| + +Called to check if the server can act as a relay in the current configuration. See :ref:`MultiplayerPeer.is_server_relay_supported`. + +.. rst-class:: classref-item-separator + +---- + .. _class_MultiplayerPeerExtension_method__poll: .. rst-class:: classref-method diff --git a/classes/class_multiplayersynchronizer.rst b/classes/class_multiplayersynchronizer.rst index cb825dfc9ff..b9f4459743a 100644 --- a/classes/class_multiplayersynchronizer.rst +++ b/classes/class_multiplayersynchronizer.rst @@ -292,7 +292,7 @@ Sets the visibility of ``peer`` to ``visible``. If ``peer`` is ``0``, the value void **update_visibility** **(** :ref:`int` for_peer=0 **)** -Updates the visibility of ``peer`` according to visibility filters. If ``peer`` is ``0`` (the default), all peers' visibilties are updated. +Updates the visibility of ``for_peer`` according to visibility filters. If ``for_peer`` is ``0`` (the default), all peers' visibilties are updated. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_navigationagent2d.rst b/classes/class_navigationagent2d.rst index 738501d32a1..eb5bc498b88 100644 --- a/classes/class_navigationagent2d.rst +++ b/classes/class_navigationagent2d.rst @@ -38,41 +38,45 @@ Properties .. table:: :widths: auto - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`bool` | :ref:`avoidance_enabled` | ``false`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`bool` | :ref:`debug_enabled` | ``false`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`Color` | :ref:`debug_path_custom_color` | ``Color(1, 1, 1, 1)`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`debug_path_custom_line_width` | ``1.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`debug_path_custom_point_size` | ``4.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`bool` | :ref:`debug_use_custom` | ``false`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`max_neighbors` | ``10`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`max_speed` | ``100.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`navigation_layers` | ``1`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`neighbor_distance` | ``500.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`path_desired_distance` | ``20.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`path_max_distance` | ``100.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`PathMetadataFlags` | :ref:`path_metadata_flags` | ``7`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`radius` | ``10.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`target_desired_distance` | ``10.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`Vector2` | :ref:`target_position` | ``Vector2(0, 0)`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`time_horizon` | ``1.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`avoidance_enabled` | ``false`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`debug_enabled` | ``false`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`debug_path_custom_color` | ``Color(1, 1, 1, 1)`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`debug_path_custom_line_width` | ``-1.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`debug_path_custom_point_size` | ``4.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`debug_use_custom` | ``false`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`max_neighbors` | ``10`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`max_speed` | ``100.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`navigation_layers` | ``1`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`neighbor_distance` | ``500.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`path_desired_distance` | ``20.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`path_max_distance` | ``100.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`PathMetadataFlags` | :ref:`path_metadata_flags` | ``7`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`PathPostProcessing` | :ref:`path_postprocessing` | ``0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`PathfindingAlgorithm` | :ref:`pathfinding_algorithm` | ``0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`radius` | ``10.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`target_desired_distance` | ``10.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Vector2` | :ref:`target_position` | ``Vector2(0, 0)`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`time_horizon` | ``1.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group @@ -191,7 +195,7 @@ Notifies when the player-defined :ref:`target_position` safe_velocity **)** -Notifies when the collision avoidance velocity is calculated. Emitted by :ref:`set_velocity`. Only emitted when :ref:`avoidance_enabled` is true. +Notifies when the collision avoidance velocity is calculated. Emitted at the end of the physics frame in which :ref:`set_velocity` is called. Only emitted when :ref:`avoidance_enabled` is true. .. rst-class:: classref-item-separator @@ -279,7 +283,7 @@ If :ref:`debug_use_custom` is .. rst-class:: classref-property -:ref:`float` **debug_path_custom_line_width** = ``1.0`` +:ref:`float` **debug_path_custom_line_width** = ``-1.0`` .. rst-class:: classref-property-setget @@ -445,6 +449,40 @@ Additional information to return with the navigation path. ---- +.. _class_NavigationAgent2D_property_path_postprocessing: + +.. rst-class:: classref-property + +:ref:`PathPostProcessing` **path_postprocessing** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_path_postprocessing** **(** :ref:`PathPostProcessing` value **)** +- :ref:`PathPostProcessing` **get_path_postprocessing** **(** **)** + +The path postprocessing applied to the raw path corridor found by the :ref:`pathfinding_algorithm`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationAgent2D_property_pathfinding_algorithm: + +.. rst-class:: classref-property + +:ref:`PathfindingAlgorithm` **pathfinding_algorithm** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_pathfinding_algorithm** **(** :ref:`PathfindingAlgorithm` value **)** +- :ref:`PathfindingAlgorithm` **get_pathfinding_algorithm** **(** **)** + +The pathfinding algorithm used in the path query. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationAgent2D_property_radius: .. rst-class:: classref-property diff --git a/classes/class_navigationagent3d.rst b/classes/class_navigationagent3d.rst index 2487aa999ae..7e1166bcdc9 100644 --- a/classes/class_navigationagent3d.rst +++ b/classes/class_navigationagent3d.rst @@ -38,43 +38,47 @@ Properties .. table:: :widths: auto - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`agent_height_offset` | ``0.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`bool` | :ref:`avoidance_enabled` | ``false`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`bool` | :ref:`debug_enabled` | ``false`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`Color` | :ref:`debug_path_custom_color` | ``Color(1, 1, 1, 1)`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`debug_path_custom_point_size` | ``4.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`bool` | :ref:`debug_use_custom` | ``false`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`bool` | :ref:`ignore_y` | ``true`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`max_neighbors` | ``10`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`max_speed` | ``10.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`int` | :ref:`navigation_layers` | ``1`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`neighbor_distance` | ``50.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`path_desired_distance` | ``1.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`path_max_distance` | ``5.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`PathMetadataFlags` | :ref:`path_metadata_flags` | ``7`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`radius` | ``0.5`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`target_desired_distance` | ``1.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`Vector3` | :ref:`target_position` | ``Vector3(0, 0, 0)`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | :ref:`float` | :ref:`time_horizon` | ``1.0`` | - +----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`agent_height_offset` | ``0.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`avoidance_enabled` | ``false`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`debug_enabled` | ``false`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`debug_path_custom_color` | ``Color(1, 1, 1, 1)`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`debug_path_custom_point_size` | ``4.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`debug_use_custom` | ``false`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`ignore_y` | ``true`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`max_neighbors` | ``10`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`max_speed` | ``10.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`navigation_layers` | ``1`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`neighbor_distance` | ``50.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`path_desired_distance` | ``1.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`path_max_distance` | ``5.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`PathMetadataFlags` | :ref:`path_metadata_flags` | ``7`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`PathPostProcessing` | :ref:`path_postprocessing` | ``0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`PathfindingAlgorithm` | :ref:`pathfinding_algorithm` | ``0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`radius` | ``0.5`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`target_desired_distance` | ``1.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Vector3` | :ref:`target_position` | ``Vector3(0, 0, 0)`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`float` | :ref:`time_horizon` | ``1.0`` | + +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group @@ -193,7 +197,7 @@ Notifies when the player-defined :ref:`target_position` safe_velocity **)** -Notifies when the collision avoidance velocity is calculated. Emitted by :ref:`set_velocity`. Only emitted when :ref:`avoidance_enabled` is true. +Notifies when the collision avoidance velocity is calculated. Emitted at the end of the physics frame in which :ref:`set_velocity` is called. Only emitted when :ref:`avoidance_enabled` is true. .. rst-class:: classref-item-separator @@ -390,7 +394,7 @@ The maximum speed that an agent can move. - void **set_navigation_layers** **(** :ref:`int` value **)** - :ref:`int` **get_navigation_layers** **(** **)** -A bitfield determining what navigation layers of navigation regions this NavigationAgent will use to calculate path. Changing it runtime will clear current navigation path and generate new one, according to new navigation layers. +A bitfield determining what navigation layers of navigation regions this agent will use to calculate path. Changing it runtime will clear current navigation path and generate new one, according to new navigation layers. .. rst-class:: classref-item-separator @@ -464,6 +468,40 @@ Additional information to return with the navigation path. ---- +.. _class_NavigationAgent3D_property_path_postprocessing: + +.. rst-class:: classref-property + +:ref:`PathPostProcessing` **path_postprocessing** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_path_postprocessing** **(** :ref:`PathPostProcessing` value **)** +- :ref:`PathPostProcessing` **get_path_postprocessing** **(** **)** + +The path postprocessing applied to the raw path corridor found by the :ref:`pathfinding_algorithm`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationAgent3D_property_pathfinding_algorithm: + +.. rst-class:: classref-property + +:ref:`PathfindingAlgorithm` **pathfinding_algorithm** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_pathfinding_algorithm** **(** :ref:`PathfindingAlgorithm` value **)** +- :ref:`PathfindingAlgorithm` **get_pathfinding_algorithm** **(** **)** + +The pathfinding algorithm used in the path query. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationAgent3D_property_radius: .. rst-class:: classref-property diff --git a/classes/class_navigationlink2d.rst b/classes/class_navigationlink2d.rst index 2383220d449..914ac5c3dda 100644 --- a/classes/class_navigationlink2d.rst +++ b/classes/class_navigationlink2d.rst @@ -149,7 +149,7 @@ The distance the link will search is controlled by :ref:`NavigationServer2D.map_ - void **set_enter_cost** **(** :ref:`float` value **)** - :ref:`float` **get_enter_cost** **(** **)** -When pathfinding enters this link from another regions navigation mesh the ``enter_cost`` value is added to the path distance for determining the shortest path. +When pathfinding enters this link from another regions navigation mesh the :ref:`enter_cost` value is added to the path distance for determining the shortest path. .. rst-class:: classref-item-separator @@ -204,7 +204,7 @@ The distance the link will search is controlled by :ref:`NavigationServer2D.map_ - void **set_travel_cost** **(** :ref:`float` value **)** - :ref:`float` **get_travel_cost** **(** **)** -When pathfinding moves along the link the traveled distance is multiplied with ``travel_cost`` for determining the shortest path. +When pathfinding moves along the link the traveled distance is multiplied with :ref:`travel_cost` for determining the shortest path. .. rst-class:: classref-section-separator diff --git a/classes/class_navigationlink3d.rst b/classes/class_navigationlink3d.rst index 2cdb258ff7a..4cb049409a7 100644 --- a/classes/class_navigationlink3d.rst +++ b/classes/class_navigationlink3d.rst @@ -149,7 +149,7 @@ The distance the link will search is controlled by :ref:`NavigationServer3D.map_ - void **set_enter_cost** **(** :ref:`float` value **)** - :ref:`float` **get_enter_cost** **(** **)** -When pathfinding enters this link from another regions navigation mesh the ``enter_cost`` value is added to the path distance for determining the shortest path. +When pathfinding enters this link from another regions navigation mesh the :ref:`enter_cost` value is added to the path distance for determining the shortest path. .. rst-class:: classref-item-separator @@ -204,7 +204,7 @@ The distance the link will search is controlled by :ref:`NavigationServer3D.map_ - void **set_travel_cost** **(** :ref:`float` value **)** - :ref:`float` **get_travel_cost** **(** **)** -When pathfinding moves along the link the traveled distance is multiplied with ``travel_cost`` for determining the shortest path. +When pathfinding moves along the link the traveled distance is multiplied with :ref:`travel_cost` for determining the shortest path. .. rst-class:: classref-section-separator diff --git a/classes/class_navigationserver2d.rst b/classes/class_navigationserver2d.rst index 2e22c032938..1d34eecbc6a 100644 --- a/classes/class_navigationserver2d.rst +++ b/classes/class_navigationserver2d.rst @@ -31,7 +31,7 @@ You may assign navigation layers to regions with :ref:`region_set_navigation_lay To use the collision avoidance system, you may use agents. You can set an agent's target velocity, then the servers will emit a callback with a modified velocity. -\ **Note:** The collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing and agent outside of a navigable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine. +\ **Note:** The collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing an agent outside of a navigable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine. This server keeps tracks of any call and executes them during the sync phase. This means that you can request any change to the map, using any thread, without worrying. diff --git a/classes/class_node.rst b/classes/class_node.rst index c024c1912b4..157d2b0e723 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -12,7 +12,7 @@ Node **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AnimationPlayer`, :ref:`AnimationTree`, :ref:`AudioStreamPlayer`, :ref:`CanvasItem`, :ref:`CanvasLayer`, :ref:`EditorFileSystem`, :ref:`EditorInterface`, :ref:`EditorPlugin`, :ref:`EditorResourcePreview`, :ref:`HTTPRequest`, :ref:`InstancePlaceholder`, :ref:`MissingNode`, :ref:`MultiplayerSpawner`, :ref:`MultiplayerSynchronizer`, :ref:`NavigationAgent2D`, :ref:`NavigationAgent3D`, :ref:`NavigationObstacle2D`, :ref:`NavigationObstacle3D`, :ref:`Node3D`, :ref:`ResourcePreloader`, :ref:`ShaderGlobalsOverride`, :ref:`SkeletonIK3D`, :ref:`Timer`, :ref:`Viewport`, :ref:`WorldEnvironment` +**Inherited By:** :ref:`AnimationPlayer`, :ref:`AnimationTree`, :ref:`AudioStreamPlayer`, :ref:`CanvasItem`, :ref:`CanvasLayer`, :ref:`EditorFileSystem`, :ref:`EditorPlugin`, :ref:`EditorResourcePreview`, :ref:`HTTPRequest`, :ref:`InstancePlaceholder`, :ref:`MissingNode`, :ref:`MultiplayerSpawner`, :ref:`MultiplayerSynchronizer`, :ref:`NavigationAgent2D`, :ref:`NavigationAgent3D`, :ref:`NavigationObstacle2D`, :ref:`NavigationObstacle3D`, :ref:`Node3D`, :ref:`ResourcePreloader`, :ref:`ShaderGlobalsOverride`, :ref:`SkeletonIK3D`, :ref:`Timer`, :ref:`Viewport`, :ref:`WorldEnvironment` Base class for all *scene* objects. @@ -291,6 +291,18 @@ When this signal is received, the child ``node`` is still in the tree and valid. ---- +.. _class_Node_signal_child_order_changed: + +.. rst-class:: classref-signal + +**child_order_changed** **(** **)** + +Emitted when the list of children is changed. This happens when child nodes are added, moved or removed. + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_signal_ready: .. rst-class:: classref-signal @@ -519,7 +531,7 @@ This notification is emitted *after* the related :ref:`tree_exiting` instead. .. _class_Node_constant_NOTIFICATION_READY: @@ -617,6 +629,14 @@ Use :ref:`Viewport.gui_is_drag_successful` when the warnings need to be updated for this node. +:: + + @export var energy = 0: + set(value): + energy = value + update_configuration_warnings() + + func _get_configuration_warnings(): + if energy < 0: + return ["Energy must be 0 or greater."] + else: + return [] + .. rst-class:: classref-item-separator ---- @@ -1212,7 +1245,7 @@ Adds a child ``node``. Nodes can have any number of children, but every child mu If ``force_readable_name`` is ``true``, improves the readability of the added ``node``. If not named, the ``node`` is renamed to its type, and if it shares :ref:`name` with a sibling, a number is suffixed more appropriately. This operation is very slow. As such, it is recommended leaving this to ``false``, which assigns a dummy name featuring ``@`` in both situations. -If ``internal`` is different than :ref:`INTERNAL_MODE_DISABLED`, the child will be added as internal node. Such nodes are ignored by methods like :ref:`get_children`, unless their parameter ``include_internal`` is ``true``.The intended usage is to hide the internal nodes from the user, so the user won't accidentally delete or modify them. Used by some GUI nodes, e.g. :ref:`ColorPicker`. See :ref:`InternalMode` for available modes. +If ``internal`` is different than :ref:`INTERNAL_MODE_DISABLED`, the child will be added as internal node. Such nodes are ignored by methods like :ref:`get_children`, unless their parameter ``include_internal`` is ``true``. The intended usage is to hide the internal nodes from the user, so the user won't accidentally delete or modify them. Used by some GUI nodes, e.g. :ref:`ColorPicker`. See :ref:`InternalMode` for available modes. \ **Note:** If the child node already has a parent, the function will fail. Use :ref:`remove_child` first to remove the node from its current parent. For example: @@ -1312,6 +1345,8 @@ Creates a new :ref:`Tween` and binds it to this node. This is equiv +The Tween will start automatically on the next process frame or physics frame (depending on :ref:`TweenProcessMode`). + .. rst-class:: classref-item-separator ---- @@ -1338,7 +1373,7 @@ You can fine-tune the behavior using the ``flags`` (see :ref:`DuplicateFlags` **find_child** **(** :ref:`String` pattern, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** |const| -Finds the first descendant of this node whose name matches ``pattern`` as in :ref:`String.match`. +Finds the first descendant of this node whose name matches ``pattern`` as in :ref:`String.match`. Internal children are also searched over (see ``internal`` parameter in :ref:`add_child`). \ ``pattern`` does not match against the full path, just against individual node names. It is case-sensitive, with ``"*"`` matching zero or more characters and ``"?"`` matching any single character except ``"."``). @@ -1362,7 +1397,7 @@ Returns ``null`` if no matching **Node** is found. :ref:`Node[]` **find_children** **(** :ref:`String` pattern, :ref:`String` type="", :ref:`bool` recursive=true, :ref:`bool` owned=true **)** |const| -Finds descendants of this node whose name matches ``pattern`` as in :ref:`String.match`, and/or type matches ``type`` as in :ref:`Object.is_class`. +Finds descendants of this node whose name matches ``pattern`` as in :ref:`String.match`, and/or type matches ``type`` as in :ref:`Object.is_class`. Internal children are also searched over (see ``internal`` parameter in :ref:`add_child`). \ ``pattern`` does not match against the full path, just against individual node names. It is case-sensitive, with ``"*"`` matching zero or more characters and ``"?"`` matching any single character except ``"."``). diff --git a/classes/class_node3d.rst b/classes/class_node3d.rst index cc0b8426d85..af9606c3be2 100644 --- a/classes/class_node3d.rst +++ b/classes/class_node3d.rst @@ -198,7 +198,7 @@ enum **RotationEditMode**: :ref:`RotationEditMode` **ROTATION_EDIT_MODE_EULER** = ``0`` - +The rotation is edited using :ref:`Vector3` Euler angles. .. _class_Node3D_constant_ROTATION_EDIT_MODE_QUATERNION: @@ -206,7 +206,7 @@ enum **RotationEditMode**: :ref:`RotationEditMode` **ROTATION_EDIT_MODE_QUATERNION** = ``1`` - +The rotation is edited using a :ref:`Quaternion`. .. _class_Node3D_constant_ROTATION_EDIT_MODE_BASIS: @@ -214,7 +214,7 @@ enum **RotationEditMode**: :ref:`RotationEditMode` **ROTATION_EDIT_MODE_BASIS** = ``2`` - +The rotation is edited using a :ref:`Basis`. In this mode, :ref:`scale` can't be edited separately. .. rst-class:: classref-section-separator diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index 8238fd1b696..65d9e7fee7b 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -297,7 +297,7 @@ For example, ``"Path2D/PathFollow2D/Sprite2D"`` has 3 names. :ref:`StringName` **get_subname** **(** :ref:`int` idx **)** |const| -Gets the resource or property name indicated by ``idx`` (0 to :ref:`get_subname_count`). +Gets the resource or property name indicated by ``idx`` (0 to :ref:`get_subname_count` - 1). .. tabs:: diff --git a/classes/class_noise.rst b/classes/class_noise.rst index b74b56833b1..467ed7075cc 100644 --- a/classes/class_noise.rst +++ b/classes/class_noise.rst @@ -35,21 +35,25 @@ Methods .. table:: :widths: auto - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`get_image` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` invert=false, :ref:`bool` in_3d_space=false, :ref:`bool` normalize=true **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_noise_1d` **(** :ref:`float` x **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_noise_2d` **(** :ref:`float` x, :ref:`float` y **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_noise_2dv` **(** :ref:`Vector2` v **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_noise_3d` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_noise_3dv` **(** :ref:`Vector3` v **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`get_seamless_image` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` invert=false, :ref:`bool` in_3d_space=false, :ref:`float` skirt=0.1, :ref:`bool` normalize=true **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`get_image` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` invert=false, :ref:`bool` in_3d_space=false, :ref:`bool` normalize=true **)** |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image[]` | :ref:`get_image_3d` **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` invert=false, :ref:`bool` normalize=true **)** |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_noise_1d` **(** :ref:`float` x **)** |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_noise_2d` **(** :ref:`float` x, :ref:`float` y **)** |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_noise_2dv` **(** :ref:`Vector2` v **)** |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_noise_3d` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_noise_3dv` **(** :ref:`Vector3` v **)** |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`get_seamless_image` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` invert=false, :ref:`bool` in_3d_space=false, :ref:`float` skirt=0.1, :ref:`bool` normalize=true **)** |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image[]` | :ref:`get_seamless_image_3d` **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` invert=false, :ref:`float` skirt=0.1, :ref:`bool` normalize=true **)** |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -66,9 +70,23 @@ Method Descriptions :ref:`Image` **get_image** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` invert=false, :ref:`bool` in_3d_space=false, :ref:`bool` normalize=true **)** |const| -Returns a 2D :ref:`Image` noise image. +Returns an :ref:`Image` containing 2D noise values. -Note: With ``normalize`` set to ``false`` the default implementation expects the noise generator to return values in the range ``-1.0`` to ``1.0``. +\ **Note:** With ``normalize`` set to ``false``, the default implementation expects the noise generator to return values in the range ``-1.0`` to ``1.0``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Noise_method_get_image_3d: + +.. rst-class:: classref-method + +:ref:`Image[]` **get_image_3d** **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` invert=false, :ref:`bool` normalize=true **)** |const| + +Returns an :ref:`Array` of :ref:`Image`\ s containing 3D noise values for use with :ref:`ImageTexture3D.create`. + +\ **Note:** With ``normalize`` set to ``false``, the default implementation expects the noise generator to return values in the range ``-1.0`` to ``1.0``. .. rst-class:: classref-item-separator @@ -140,9 +158,23 @@ Returns the 3D noise value at the given position. :ref:`Image` **get_seamless_image** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` invert=false, :ref:`bool` in_3d_space=false, :ref:`float` skirt=0.1, :ref:`bool` normalize=true **)** |const| -Returns a seamless 2D :ref:`Image` noise image. +Returns an :ref:`Image` containing seamless 2D noise values. + +\ **Note:** With ``normalize`` set to ``false``, the default implementation expects the noise generator to return values in the range ``-1.0`` to ``1.0``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Noise_method_get_seamless_image_3d: + +.. rst-class:: classref-method + +:ref:`Image[]` **get_seamless_image_3d** **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` invert=false, :ref:`float` skirt=0.1, :ref:`bool` normalize=true **)** |const| + +Returns an :ref:`Array` of :ref:`Image`\ s containing seamless 3D noise values for use with :ref:`ImageTexture3D.create`. -Note: With ``normalize`` set to ``false`` the default implementation expects the noise generator to return values in the range ``-1.0`` to ``1.0``. +\ **Note:** With ``normalize`` set to ``false``, the default implementation expects the noise generator to return values in the range ``-1.0`` to ``1.0``. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_noisetexture3d.rst b/classes/class_noisetexture3d.rst new file mode 100644 index 00000000000..568a03919f1 --- /dev/null +++ b/classes/class_noisetexture3d.rst @@ -0,0 +1,228 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/noise/doc_classes/NoiseTexture3D.xml. + +.. _class_NoiseTexture3D: + +NoiseTexture3D +============== + +**Inherits:** :ref:`Texture3D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +A texture filled with noise generated by a :ref:`Noise` object. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Uses :ref:`FastNoiseLite` or other libraries to fill the texture data of your desired size. + +The class uses :ref:`Thread`\ s to generate the texture data internally, so :ref:`Texture3D.get_data` may return ``null`` if the generation process has not completed yet. In that case, you need to wait for the texture to be generated before accessing the image: + +:: + + var texture = NoiseTexture3D.new() + texture.noise = FastNoiseLite.new() + await texture.changed + var data = texture.get_data() + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------------+---------------------------------------------------------------------------------+-----------+ + | :ref:`Gradient` | :ref:`color_ramp` | | + +---------------------------------+---------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`depth` | ``64`` | + +---------------------------------+---------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`height` | ``64`` | + +---------------------------------+---------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`invert` | ``false`` | + +---------------------------------+---------------------------------------------------------------------------------+-----------+ + | :ref:`Noise` | :ref:`noise` | | + +---------------------------------+---------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`normalize` | ``true`` | + +---------------------------------+---------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`seamless` | ``false`` | + +---------------------------------+---------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`seamless_blend_skirt` | ``0.1`` | + +---------------------------------+---------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`width` | ``64`` | + +---------------------------------+---------------------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_NoiseTexture3D_property_color_ramp: + +.. rst-class:: classref-property + +:ref:`Gradient` **color_ramp** + +.. rst-class:: classref-property-setget + +- void **set_color_ramp** **(** :ref:`Gradient` value **)** +- :ref:`Gradient` **get_color_ramp** **(** **)** + +A :ref:`Gradient` which is used to map the luminance of each pixel to a color value. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NoiseTexture3D_property_depth: + +.. rst-class:: classref-property + +:ref:`int` **depth** = ``64`` + +.. rst-class:: classref-property-setget + +- void **set_depth** **(** :ref:`int` value **)** +- :ref:`int` **get_depth** **(** **)** + +Depth of the generated texture. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NoiseTexture3D_property_height: + +.. rst-class:: classref-property + +:ref:`int` **height** = ``64`` + +.. rst-class:: classref-property-setget + +- void **set_height** **(** :ref:`int` value **)** +- :ref:`int` **get_height** **(** **)** + +Height of the generated texture. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NoiseTexture3D_property_invert: + +.. rst-class:: classref-property + +:ref:`bool` **invert** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_invert** **(** :ref:`bool` value **)** +- :ref:`bool` **get_invert** **(** **)** + +If ``true``, inverts the noise texture. White becomes black, black becomes white. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NoiseTexture3D_property_noise: + +.. rst-class:: classref-property + +:ref:`Noise` **noise** + +.. rst-class:: classref-property-setget + +- void **set_noise** **(** :ref:`Noise` value **)** +- :ref:`Noise` **get_noise** **(** **)** + +The instance of the :ref:`Noise` object. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NoiseTexture3D_property_normalize: + +.. rst-class:: classref-property + +:ref:`bool` **normalize** = ``true`` + +.. rst-class:: classref-property-setget + +- void **set_normalize** **(** :ref:`bool` value **)** +- :ref:`bool` **is_normalized** **(** **)** + +If ``true``, the noise image coming from the noise generator is normalized to the range ``0.0`` to ``1.0``. + +Turning normalization off can affect the contrast and allows you to generate non repeating tileable noise textures. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NoiseTexture3D_property_seamless: + +.. rst-class:: classref-property + +:ref:`bool` **seamless** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_seamless** **(** :ref:`bool` value **)** +- :ref:`bool` **get_seamless** **(** **)** + +If ``true``, a seamless texture is requested from the :ref:`Noise` resource. + +\ **Note:** Seamless noise textures may take longer to generate and/or can have a lower contrast compared to non-seamless noise depending on the used :ref:`Noise` resource. This is because some implementations use higher dimensions for generating seamless noise. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NoiseTexture3D_property_seamless_blend_skirt: + +.. rst-class:: classref-property + +:ref:`float` **seamless_blend_skirt** = ``0.1`` + +.. rst-class:: classref-property-setget + +- void **set_seamless_blend_skirt** **(** :ref:`float` value **)** +- :ref:`float` **get_seamless_blend_skirt** **(** **)** + +Used for the default/fallback implementation of the seamless texture generation. It determines the distance over which the seams are blended. High values may result in less details and contrast. See :ref:`Noise` for further details. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NoiseTexture3D_property_width: + +.. rst-class:: classref-property + +:ref:`int` **width** = ``64`` + +.. rst-class:: classref-property-setget + +- void **set_width** **(** :ref:`int` value **)** +- :ref:`int` **get_width** **(** **)** + +Width of the generated texture. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_object.rst b/classes/class_object.rst index 54ff310e4ff..ddcb18806bd 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -10,7 +10,7 @@ Object ====== -**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`GodotSharp`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`WorkerThreadPool`, :ref:`XRServer` +**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorInterface`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`GodotSharp`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`WorkerThreadPool`, :ref:`XRServer` Base class for all other classes in the engine. @@ -1200,7 +1200,7 @@ Returns ``true`` if a metadata entry is found with the given ``name``. See also :ref:`bool` **has_method** **(** :ref:`StringName` method **)** |const| -Returns ``true`` if the the given ``method`` name exists in the object. +Returns ``true`` if the given ``method`` name exists in the object. \ **Note:** In C#, ``method`` must be in snake_case when referring to built-in Godot methods. Prefer using the names exposed in the ``MethodName`` class to avoid allocating a new :ref:`StringName` on each call. diff --git a/classes/class_openxraction.rst b/classes/class_openxraction.rst index 88caa6fa895..54ad62752c4 100644 --- a/classes/class_openxraction.rst +++ b/classes/class_openxraction.rst @@ -80,7 +80,7 @@ This action provides a float value between ``0.0`` and ``1.0`` for any analog in :ref:`ActionType` **OPENXR_ACTION_VECTOR2** = ``2`` -This action provides a vector2 value and can be bound to embedded trackpads and joysticks +This action provides a :ref:`Vector2` value and can be bound to embedded trackpads and joysticks. .. _class_OpenXRAction_constant_OPENXR_ACTION_POSE: diff --git a/classes/class_openxrinterface.rst b/classes/class_openxrinterface.rst index d8baf219065..b8178cf599d 100644 --- a/classes/class_openxrinterface.rst +++ b/classes/class_openxrinterface.rst @@ -38,9 +38,11 @@ Properties .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------------------------+---------+ - | :ref:`float` | :ref:`display_refresh_rate` | ``0.0`` | - +---------------------------+----------------------------------------------------------------------------------+---------+ + +---------------------------+----------------------------------------------------------------------------------------------------+---------+ + | :ref:`float` | :ref:`display_refresh_rate` | ``0.0`` | + +---------------------------+----------------------------------------------------------------------------------------------------+---------+ + | :ref:`float` | :ref:`render_target_size_multiplier` | ``1.0`` | + +---------------------------+----------------------------------------------------------------------------------------------------+---------+ .. rst-class:: classref-reftable-group @@ -147,6 +149,23 @@ Property Descriptions The display refresh rate for the current HMD. Only functional if this feature is supported by the OpenXR runtime and after the interface has been initialized. +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRInterface_property_render_target_size_multiplier: + +.. rst-class:: classref-property + +:ref:`float` **render_target_size_multiplier** = ``1.0`` + +.. rst-class:: classref-property-setget + +- void **set_render_target_size_multiplier** **(** :ref:`float` value **)** +- :ref:`float` **get_render_target_size_multiplier** **(** **)** + +The render size multiplier for the current HMD. Must be set before the interface has been initialized. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 98804436afa..d2c5516ccfc 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -38,6 +38,8 @@ Properties +-------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`HorizontalAlignment` | alignment | ``0`` (overrides :ref:`Button`) | +-------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`allow_reselect` | ``false`` | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`fit_to_longest_item` | ``true`` | +-------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`int` | :ref:`item_count` | ``0`` | @@ -194,6 +196,8 @@ Emitted when the user navigates to an item using the :ref:`ProjectSettings.input Emitted when the current item has been changed by the user. The index of the item selected is passed as argument. +\ :ref:`allow_reselect` must be enabled to reselect an item. + .. rst-class:: classref-section-separator ---- @@ -203,6 +207,23 @@ Emitted when the current item has been changed by the user. The index of the ite Property Descriptions --------------------- +.. _class_OptionButton_property_allow_reselect: + +.. rst-class:: classref-property + +:ref:`bool` **allow_reselect** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_allow_reselect** **(** :ref:`bool` value **)** +- :ref:`bool` **get_allow_reselect** **(** **)** + +If ``true``, the currently selected item can be selected again. + +.. rst-class:: classref-item-separator + +---- + .. _class_OptionButton_property_fit_to_longest_item: .. rst-class:: classref-property diff --git a/classes/class_os.rst b/classes/class_os.rst index e22b276da04..2e71b882143 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -19,7 +19,7 @@ Operating System functions. Description ----------- -Operating System functions. **OS** wraps the most common functionality to communicate with the host operating system, such as the clipboard, video driver, delays, environment variables, execution of binaries, command line, etc. +Operating System functions. **OS** wraps the most common functionality to communicate with the host operating system, such as the video driver, delays, environment variables, execution of binaries, command line, etc. \ **Note:** In Godot 4, **OS** functions related to window management were moved to the :ref:`DisplayServer` singleton. @@ -99,6 +99,8 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_main_thread_id` **(** **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_memory_info` **(** **)** |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_model_name` **(** **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_name` **(** **)** |const| | @@ -171,6 +173,8 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`shell_open` **(** :ref:`String` uri **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`shell_show_in_file_manager` **(** :ref:`String` file_or_dir_path, :ref:`bool` open_folder=true **)** | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`unset_environment` **(** :ref:`String` variable **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -783,6 +787,26 @@ Returns the ID of the main thread. See :ref:`get_thread_caller_id` **get_memory_info** **(** **)** |const| + +Returns the :ref:`Dictionary` with the following keys: + +\ ``"physical"`` - total amount of usable physical memory, in bytes or ``-1`` if unknown. This value can be slightly less than the actual physical memory amount, since it does not include memory reserved by kernel and devices. + +\ ``"free"`` - amount of physical memory, that can be immediately allocated without disk access or other costly operation, in bytes or ``-1`` if unknown. The process might be able to allocate more physical memory, but such allocation will require moving inactive pages to disk and can take some time. + +\ ``"available"`` - amount of memory, that can be allocated without extending the swap file(s), in bytes or ``-1`` if unknown. This value include both physical memory and swap. + +\ ``"stack"`` - size of the current thread stack, in bytes or ``-1`` if unknown. + +.. rst-class:: classref-item-separator + +---- + .. _class_OS_method_get_model_name: .. rst-class:: classref-method @@ -1141,6 +1165,8 @@ Returns ``true`` if the feature for the given feature tag is supported in the cu \ **Note:** Tag names are case-sensitive. +\ **Note:** On the web platform, one of the following additional tags is defined to indicate host platform: ``web_android``, ``web_ios``, ``web_linuxbsd``, ``web_macos``, or ``web_windows``. + .. rst-class:: classref-item-separator ---- @@ -1398,12 +1424,32 @@ Requests the OS to open a resource with the most appropriate program. For exampl Use :ref:`ProjectSettings.globalize_path` to convert a ``res://`` or ``user://`` path into a system path for use with this method. +\ **Note:** Use :ref:`String.uri_encode` to encode characters within URLs in a URL-safe, portable way. This is especially required for line breaks. Otherwise, :ref:`shell_open` may not work correctly in a project exported to the Web platform. + \ **Note:** This method is implemented on Android, iOS, Web, Linux, macOS and Windows. .. rst-class:: classref-item-separator ---- +.. _class_OS_method_shell_show_in_file_manager: + +.. rst-class:: classref-method + +:ref:`Error` **shell_show_in_file_manager** **(** :ref:`String` file_or_dir_path, :ref:`bool` open_folder=true **)** + +Requests the OS to open file manager, then navigate to the given ``file_or_dir_path`` and select the target file or folder. + +If ``file_or_dir_path`` is a valid directory path, and ``open_folder`` is ``true``, the method will open explorer and enter the target folder without selecting anything. + +Use :ref:`ProjectSettings.globalize_path` to convert a ``res://`` or ``user://`` path into a system path for use with this method. + +\ **Note:** Currently this method is only implemented on Windows. On other platforms, it will fallback to :ref:`shell_open` with a directory path for ``file_or_dir_path``. + +.. rst-class:: classref-item-separator + +---- + .. _class_OS_method_unset_environment: .. rst-class:: classref-method diff --git a/classes/class_packedbytearray.rst b/classes/class_packedbytearray.rst index 003c260869d..f23a987b598 100644 --- a/classes/class_packedbytearray.rst +++ b/classes/class_packedbytearray.rst @@ -126,6 +126,8 @@ Methods +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_string_from_utf8` **(** **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_string_from_wchar` **(** **)** |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has` **(** :ref:`int` value **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_encoded_var` **(** :ref:`int` byte_offset, :ref:`bool` allow_objects=false **)** |const| | @@ -475,7 +477,7 @@ Returns a new **PackedByteArray** with the data decompressed. Set ``buffer_size` :ref:`PackedByteArray` **decompress_dynamic** **(** :ref:`int` max_output_size, :ref:`int` compression_mode=0 **)** |const| -Returns a new **PackedByteArray** with the data decompressed. Set the compression mode using one of :ref:`CompressionMode`'s constants. **This method only accepts gzip and deflate compression modes.**\ +Returns a new **PackedByteArray** with the data decompressed. Set the compression mode using one of :ref:`CompressionMode`'s constants. **This method only accepts brotli, gzip, and deflate compression modes.**\ This method is potentially slower than ``decompress``, as it may have to re-allocate its output buffer multiple times while decompressing, whereas ``decompress`` knows it's output buffer size from the beginning. @@ -713,6 +715,18 @@ Converts UTF-8 encoded array to :ref:`String`. Slower than :ref:`g ---- +.. _class_PackedByteArray_method_get_string_from_wchar: + +.. rst-class:: classref-method + +:ref:`String` **get_string_from_wchar** **(** **)** |const| + +Converts wide character (``wchar_t``, UTF-16 on Windows, UTF-32 on other platforms) encoded array to :ref:`String`. Returns empty string if source array is not valid wide string. + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedByteArray_method_has: .. rst-class:: classref-method diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 0f97d6d05c8..f2035033c1b 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -246,7 +246,7 @@ Waits for a packet to arrive on the bound address. See :ref:`bind` value **)** - :ref:`bool` **get_turbulence_enabled** **(** **)** -Enables and disables Turbulence for the particle system. +If ``true``, enables turbulence for the particle system. Turbulence can be used to vary particle movement according to its position (based on a 3D noise pattern). In 3D, :ref:`GPUParticlesAttractorVectorField3D` with :ref:`NoiseTexture3D` can be used as an alternative to turbulence that works in world space and with multiple particle systems reacting in the same way. + +\ **Note:** Enabling turbulence has a high performance cost on the GPU. Only enable turbulence on a few particle systems at once at most, and consider disabling it when targeting mobile/web platforms. .. rst-class:: classref-item-separator @@ -1772,9 +1774,9 @@ Enables and disables Turbulence for the particle system. - void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| -Minimum turbulence influence on each particle. +Maximum turbulence influence on each particle. - The actual amount of turbulence influence on each particle is calculated as a random value between :ref:`turbulence_influence_min` and :ref:`turbulence_influence_max` and multiplied by the amount of turbulence influence from :ref:`turbulence_influence_over_life`. +The actual amount of turbulence influence on each particle is calculated as a random value between :ref:`turbulence_influence_min` and :ref:`turbulence_influence_max` and multiplied by the amount of turbulence influence from :ref:`turbulence_influence_over_life`. .. rst-class:: classref-item-separator @@ -1791,7 +1793,7 @@ Minimum turbulence influence on each particle. - void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| -Maximum turbulence influence on each particle. +Minimum turbulence influence on each particle. The actual amount of turbulence influence on each particle is calculated as a random value between :ref:`turbulence_influence_min` and :ref:`turbulence_influence_max` and multiplied by the amount of turbulence influence from :ref:`turbulence_influence_over_life`. @@ -1827,7 +1829,7 @@ Each particle's amount of turbulence will be influenced along this :ref:`CurveTe - void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| -Maximum displacement of each particles spawn position by the turbulence. +Maximum displacement of each particle's spawn position by the turbulence. The actual amount of displacement will be a factor of the underlying turbulence multiplied by a random value between :ref:`turbulence_initial_displacement_min` and :ref:`turbulence_initial_displacement_max`. @@ -1846,7 +1848,7 @@ The actual amount of displacement will be a factor of the underlying turbulence - void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| -Minimum displacement of each particles spawn position by the turbulence. +Minimum displacement of each particle's spawn position by the turbulence. The actual amount of displacement will be a factor of the underlying turbulence multiplied by a random value between :ref:`turbulence_initial_displacement_min` and :ref:`turbulence_initial_displacement_max`. @@ -1903,7 +1905,7 @@ A value of ``Vector3(0.0, 0.0, 0.0)`` will freeze the turbulence pattern in plac - void **set_turbulence_noise_speed_random** **(** :ref:`float` value **)** - :ref:`float` **get_turbulence_noise_speed_random** **(** **)** -Use to influence the noise speed in a random pattern. This helps to break up visible movement patterns. +Use to influence the noise speed in a random pattern. This helps break up visible movement patterns. .. rst-class:: classref-item-separator @@ -1920,7 +1922,7 @@ Use to influence the noise speed in a random pattern. This helps to break up vis - void **set_turbulence_noise_strength** **(** :ref:`float` value **)** - :ref:`float` **get_turbulence_noise_strength** **(** **)** -The turbulence noise strength. Increasing this will result in a stronger, more contrasting, noise pattern. +The turbulence noise strength. Increasing this will result in a stronger, more contrasting noise pattern. .. rst-class:: classref-section-separator diff --git a/classes/class_physicsdirectbodystate2d.rst b/classes/class_physicsdirectbodystate2d.rst index 5836d976eaa..105cb9f7cff 100644 --- a/classes/class_physicsdirectbodystate2d.rst +++ b/classes/class_physicsdirectbodystate2d.rst @@ -119,6 +119,8 @@ Methods +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_contact_local_velocity_at_position` **(** :ref:`int` contact_idx **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PhysicsDirectSpaceState2D` | :ref:`get_space_state` **(** **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_velocity_at_local_position` **(** :ref:`Vector2` local_position **)** |const| | @@ -564,7 +566,7 @@ Returns the collider's shape index. :ref:`Vector2` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** |const| -Returns the linear velocity vector at the collider's contact point. +Returns the velocity vector at the collider's contact point. .. rst-class:: classref-item-separator @@ -632,6 +634,18 @@ Returns the local shape index of the collision. ---- +.. _class_PhysicsDirectBodyState2D_method_get_contact_local_velocity_at_position: + +.. rst-class:: classref-method + +:ref:`Vector2` **get_contact_local_velocity_at_position** **(** :ref:`int` contact_idx **)** |const| + +Returns the velocity vector at the body's contact point. + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsDirectBodyState2D_method_get_space_state: .. rst-class:: classref-method diff --git a/classes/class_physicsdirectbodystate2dextension.rst b/classes/class_physicsdirectbodystate2dextension.rst index 0c041a6a71c..40f8571a580 100644 --- a/classes/class_physicsdirectbodystate2dextension.rst +++ b/classes/class_physicsdirectbodystate2dextension.rst @@ -75,6 +75,8 @@ Methods +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_contact_local_shape` **(** :ref:`int` contact_idx **)** |virtual| |const| | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contact_local_velocity_at_position` **(** :ref:`int` contact_idx **)** |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_get_inverse_inertia` **(** **)** |virtual| |const| | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_get_inverse_mass` **(** **)** |virtual| |const| | @@ -471,6 +473,20 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi ---- +.. _class_PhysicsDirectBodyState2DExtension_method__get_contact_local_velocity_at_position: + +.. rst-class:: classref-method + +:ref:`Vector2` **_get_contact_local_velocity_at_position** **(** :ref:`int` contact_idx **)** |virtual| |const| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsDirectBodyState2DExtension_method__get_inverse_inertia: .. rst-class:: classref-method diff --git a/classes/class_physicsdirectbodystate3d.rst b/classes/class_physicsdirectbodystate3d.rst index f35d9394406..14e8b0b7bd2 100644 --- a/classes/class_physicsdirectbodystate3d.rst +++ b/classes/class_physicsdirectbodystate3d.rst @@ -123,6 +123,8 @@ Methods +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_contact_local_velocity_at_position` **(** :ref:`int` contact_idx **)** |const| | + +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PhysicsDirectSpaceState3D` | :ref:`get_space_state` **(** **)** | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_velocity_at_local_position` **(** :ref:`Vector3` local_position **)** |const| | @@ -670,6 +672,18 @@ Returns the local shape index of the collision. ---- +.. _class_PhysicsDirectBodyState3D_method_get_contact_local_velocity_at_position: + +.. rst-class:: classref-method + +:ref:`Vector3` **get_contact_local_velocity_at_position** **(** :ref:`int` contact_idx **)** |const| + +Returns the linear velocity vector at the body's contact point. + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsDirectBodyState3D_method_get_space_state: .. rst-class:: classref-method diff --git a/classes/class_physicsdirectbodystate3dextension.rst b/classes/class_physicsdirectbodystate3dextension.rst index 203a98af66f..3f79037ea7c 100644 --- a/classes/class_physicsdirectbodystate3dextension.rst +++ b/classes/class_physicsdirectbodystate3dextension.rst @@ -75,6 +75,8 @@ Methods +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_contact_local_shape` **(** :ref:`int` contact_idx **)** |virtual| |const| | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_contact_local_velocity_at_position` **(** :ref:`int` contact_idx **)** |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`_get_inverse_inertia` **(** **)** |virtual| |const| | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`_get_inverse_inertia_tensor` **(** **)** |virtual| |const| | @@ -475,6 +477,20 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** ---- +.. _class_PhysicsDirectBodyState3DExtension_method__get_contact_local_velocity_at_position: + +.. rst-class:: classref-method + +:ref:`Vector3` **_get_contact_local_velocity_at_position** **(** :ref:`int` contact_idx **)** |virtual| |const| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_PhysicsDirectBodyState3DExtension_method__get_inverse_inertia: .. rst-class:: classref-method diff --git a/classes/class_physicsdirectspacestate2d.rst b/classes/class_physicsdirectspacestate2d.rst index 9eb74269c57..06900c82ab7 100644 --- a/classes/class_physicsdirectspacestate2d.rst +++ b/classes/class_physicsdirectspacestate2d.rst @@ -40,19 +40,19 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters2D` parameters **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array[]` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=32 **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters2D` parameters **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`intersect_point` **(** :ref:`PhysicsPointQueryParameters2D` parameters, :ref:`int` max_results=32 **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`PhysicsRayQueryParameters2D` parameters **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=32 **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters2D` parameters **)** | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2[]` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=32 **)** | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters2D` parameters **)** | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary[]` | :ref:`intersect_point` **(** :ref:`PhysicsPointQueryParameters2D` parameters, :ref:`int` max_results=32 **)** | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`PhysicsRayQueryParameters2D` parameters **)** | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary[]` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=32 **)** | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -83,7 +83,7 @@ Returns an array with the safe and unsafe proportions (between 0 and 1) of the m .. rst-class:: classref-method -:ref:`PackedVector2Array[]` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=32 **)** +:ref:`Vector2[]` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=32 **)** Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters2D` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. diff --git a/classes/class_physicsdirectspacestate3d.rst b/classes/class_physicsdirectspacestate3d.rst index add7f8194dc..4b52ab791e4 100644 --- a/classes/class_physicsdirectspacestate3d.rst +++ b/classes/class_physicsdirectspacestate3d.rst @@ -40,19 +40,19 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters3D` parameters **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array[]` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=32 **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters3D` parameters **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`intersect_point` **(** :ref:`PhysicsPointQueryParameters3D` parameters, :ref:`int` max_results=32 **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`PhysicsRayQueryParameters3D` parameters **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=32 **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters3D` parameters **)** | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3[]` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=32 **)** | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters3D` parameters **)** | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary[]` | :ref:`intersect_point` **(** :ref:`PhysicsPointQueryParameters3D` parameters, :ref:`int` max_results=32 **)** | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`PhysicsRayQueryParameters3D` parameters **)** | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary[]` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=32 **)** | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -83,7 +83,7 @@ Returns an array with the safe and unsafe proportions (between 0 and 1) of the m .. rst-class:: classref-method -:ref:`PackedVector3Array[]` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=32 **)** +:ref:`Vector3[]` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=32 **)** Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters3D` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. diff --git a/classes/class_physicsdirectspacestate3dextension.rst b/classes/class_physicsdirectspacestate3dextension.rst index 6c2c4cab66a..edb1614d425 100644 --- a/classes/class_physicsdirectspacestate3dextension.rst +++ b/classes/class_physicsdirectspacestate3dextension.rst @@ -33,7 +33,7 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_intersect_point` **(** :ref:`Vector3` position, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer3DExtensionShapeResult* results, :ref:`int` max_results **)** |virtual| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, :ref:`bool` hit_from_inside, :ref:`bool` hit_back_faces, PhysicsServer3DExtensionRayResult* result **)** |virtual| | + | :ref:`bool` | :ref:`_intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, :ref:`bool` hit_from_inside, :ref:`bool` hit_back_faces, :ref:`bool` pick_ray, PhysicsServer3DExtensionRayResult* result **)** |virtual| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_intersect_shape` **(** :ref:`RID` shape_rid, :ref:`Transform3D` transform, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer3DExtensionShapeResult* result_count, :ref:`int` max_results **)** |virtual| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -111,7 +111,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, :ref:`bool` hit_from_inside, :ref:`bool` hit_back_faces, PhysicsServer3DExtensionRayResult* result **)** |virtual| +:ref:`bool` **_intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, :ref:`bool` hit_from_inside, :ref:`bool` hit_back_faces, :ref:`bool` pick_ray, PhysicsServer3DExtensionRayResult* result **)** |virtual| .. container:: contribute diff --git a/classes/class_physicsserver3d.rst b/classes/class_physicsserver3d.rst index 579a08a3354..9e0f5141c87 100644 --- a/classes/class_physicsserver3d.rst +++ b/classes/class_physicsserver3d.rst @@ -1799,9 +1799,19 @@ Removes a shape from an area. It does not delete the shape, so it can be reassig void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** -.. container:: contribute +Sets the area's area monitor callback. This callback will be called when any other (shape of an) area enters or exits (a shape of) the given area, and must take the following five parameters: - There is currently no description for this method. Please help us by :ref:`contributing one `! +1. an integer ``status``: either :ref:`AREA_BODY_ADDED` or :ref:`AREA_BODY_REMOVED` depending on whether the other area's shape entered or exited the area, + +2. an :ref:`RID` ``area_rid``: the :ref:`RID` of the other area that entered or exited the area, + +3. an integer ``instance_id``: the ``ObjectID`` attached to the other area, + +4. an integer ``area_shape_idx``: the index of the shape of the other area that entered or exited the area, + +5. an integer ``self_shape_idx``: the index of the shape of the area where the other area entered or exited. + +By counting (or keeping track of) the shapes that enter and exit, it can be determined if an area (with all its shapes) is entering for the first time or exiting for the last time. .. rst-class:: classref-item-separator @@ -1837,17 +1847,19 @@ Sets which physics layers the area will monitor. void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** -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: +Sets the area's body monitor callback. This callback will be called when any other (shape of a) body enters or exits (a shape of) the given area, and must take the following five parameters: + +1. an integer ``status``: either :ref:`AREA_BODY_ADDED` or :ref:`AREA_BODY_REMOVED` depending on whether the other body shape entered or exited the area, -1: :ref:`AREA_BODY_ADDED` or :ref:`AREA_BODY_REMOVED`, depending on whether the object entered or exited the area. +2. an :ref:`RID` ``body_rid``: the :ref:`RID` of the body that entered or exited the area, -2: :ref:`RID` of the object that entered/exited the area. +3. an integer ``instance_id``: the ``ObjectID`` attached to the body, -3: Instance ID of the object that entered/exited the area. +4. an integer ``body_shape_idx``: the index of the shape of the body that entered or exited the area, -4: The shape index of the object that entered/exited the area. +5. an integer ``self_shape_idx``: the index of the shape of the area where the body entered or exited. -5: The shape index of the area where the object entered/exited. +By counting (or keeping track of) the shapes that enter and exit, it can be determined if a body (with all its shapes) is entering for the first time or exiting for the last time. .. rst-class:: classref-item-separator diff --git a/classes/class_physicsserver3dextension.rst b/classes/class_physicsserver3dextension.rst index a27eba3685c..c0fb05fa286 100644 --- a/classes/class_physicsserver3dextension.rst +++ b/classes/class_physicsserver3dextension.rst @@ -24,387 +24,387 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform3D` transform, :ref:`bool` disabled **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_clear_shapes` **(** :ref:`RID` area **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_collision_layer` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_collision_mask` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_object_instance_id` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_shape_count` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`_area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_get_space` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`_area_get_transform` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_ray_pickable` **(** :ref:`RID` area, :ref:`bool` enable **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_transform` **(** :ref:`RID` area, :ref:`Transform3D` transform **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_constant_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_constant_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_constant_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform3D` transform, :ref:`bool` disabled **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse, :ref:`Vector3` position **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_clear_shapes` **(** :ref:`RID` body **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`_body_get_collision_exceptions` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_collision_layer` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_collision_mask` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_body_get_collision_priority` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_body_get_constant_force` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_body_get_constant_torque` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_body_get_contacts_reported_depth_threshold` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectBodyState3D` | :ref:`_body_get_direct_state` **(** :ref:`RID` body **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_max_contacts_reported` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`BodyMode` | :ref:`_body_get_mode` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_object_instance_id` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_shape_count` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`_body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_get_space` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_user_flags` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_is_axis_locked` **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_is_continuous_collision_detection_enabled` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_is_omitting_force_integration` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_reset_mass_properties` **(** :ref:`RID` body **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_axis_lock` **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_collision_priority` **(** :ref:`RID` body, :ref:`float` priority **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_constant_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_constant_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_contacts_reported_depth_threshold` **(** :ref:`RID` body, :ref:`float` threshold **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_state_sync_callback` **(** :ref:`RID` body, :ref:`Callable` callable **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_user_flags` **(** :ref:`RID` body, :ref:`int` flags **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_test_motion` **(** :ref:`RID` body, :ref:`Transform3D` from, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` max_collisions, :ref:`bool` collide_separation_ray, PhysicsServer3DExtensionMotionResult* result **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_box_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_capsule_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_concave_polygon_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_cone_twist_joint_get_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_cone_twist_joint_set_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_convex_polygon_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_custom_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_cylinder_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_end_sync` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_finish` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_flush_queries` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_free_rid` **(** :ref:`RID` rid **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_generic_6dof_joint_get_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_generic_6dof_joint_get_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_generic_6dof_joint_set_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_generic_6dof_joint_set_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_process_info` **(** :ref:`ProcessInfo` process_info **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_heightmap_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_hinge_joint_get_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_hinge_joint_get_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_hinge_joint_set_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_hinge_joint_set_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_init` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_flushing_queries` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_clear` **(** :ref:`RID` joint **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_joint_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_disable_collisions_between_bodies` **(** :ref:`RID` joint, :ref:`bool` disable **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_joint_get_solver_priority` **(** :ref:`RID` joint **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`JointType` | :ref:`_joint_get_type` **(** :ref:`RID` joint **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_joint_is_disabled_collisions_between_bodies` **(** :ref:`RID` joint **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_cone_twist` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_generic_6dof` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_hinge` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` hinge_A, :ref:`RID` body_B, :ref:`Transform3D` hinge_B **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_hinge_simple` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Vector3` pivot_A, :ref:`Vector3` axis_A, :ref:`RID` body_B, :ref:`Vector3` pivot_B, :ref:`Vector3` axis_B **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_pin` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_slider` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_set_solver_priority` **(** :ref:`RID` joint, :ref:`int` priority **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_pin_joint_get_local_a` **(** :ref:`RID` joint **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_pin_joint_get_local_b` **(** :ref:`RID` joint **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_pin_joint_set_local_a` **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_pin_joint_set_local_b` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_separation_ray_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_active` **(** :ref:`bool` active **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shape_get_custom_solver_bias` **(** :ref:`RID` shape **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_shape_get_data` **(** :ref:`RID` shape **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shape_get_margin` **(** :ref:`RID` shape **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ShapeType` | :ref:`_shape_get_type` **(** :ref:`RID` shape **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shape_set_custom_solver_bias` **(** :ref:`RID` shape, :ref:`float` bias **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shape_set_margin` **(** :ref:`RID` shape, :ref:`float` margin **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_slider_joint_get_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_slider_joint_set_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` body_b **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_soft_body_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`_soft_body_get_bounds` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`_soft_body_get_collision_exceptions` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_soft_body_get_collision_layer` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_soft_body_get_collision_mask` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_damping_coefficient` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_drag_coefficient` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_linear_stiffness` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_soft_body_get_point_global_position` **(** :ref:`RID` body, :ref:`int` point_index **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_pressure_coefficient` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_soft_body_get_simulation_precision` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_soft_body_get_space` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_soft_body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_total_mass` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_soft_body_is_point_pinned` **(** :ref:`RID` body, :ref:`int` point_index **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_move_point` **(** :ref:`RID` body, :ref:`int` point_index, :ref:`Vector3` global_position **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_pin_point` **(** :ref:`RID` body, :ref:`int` point_index, :ref:`bool` pin **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_remove_all_pinned_points` **(** :ref:`RID` body **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` body_b **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_damping_coefficient` **(** :ref:`RID` body, :ref:`float` damping_coefficient **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_drag_coefficient` **(** :ref:`RID` body, :ref:`float` drag_coefficient **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_linear_stiffness` **(** :ref:`RID` body, :ref:`float` linear_stiffness **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_mesh` **(** :ref:`RID` body, :ref:`RID` mesh **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_pressure_coefficient` **(** :ref:`RID` body, :ref:`float` pressure_coefficient **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_simulation_precision` **(** :ref:`RID` body, :ref:`int` simulation_precision **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` variant **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_total_mass` **(** :ref:`RID` body, :ref:`float` total_mass **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_transform` **(** :ref:`RID` body, :ref:`Transform3D` transform **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_update_rendering_server` **(** :ref:`RID` body, :ref:`PhysicsServer3DRenderingServerHandler` rendering_server_handler **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_space_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_space_get_contact_count` **(** :ref:`RID` space **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`_space_get_contacts` **(** :ref:`RID` space **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectSpaceState3D` | :ref:`_space_get_direct_state` **(** :ref:`RID` space **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_space_is_active` **(** :ref:`RID` space **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_space_set_debug_contacts` **(** :ref:`RID` space, :ref:`int` max_contacts **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_sphere_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_step` **(** :ref:`float` step **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_sync` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_world_boundary_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_test_motion_is_excluding_body` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_test_motion_is_excluding_object` **(** :ref:`int` object **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform3D` transform, :ref:`bool` disabled **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_clear_shapes` **(** :ref:`RID` area **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_collision_layer` **(** :ref:`RID` area **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_collision_mask` **(** :ref:`RID` area **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_object_instance_id` **(** :ref:`RID` area **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_shape_count` **(** :ref:`RID` area **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_get_space` **(** :ref:`RID` area **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_area_get_transform` **(** :ref:`RID` area **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_set_ray_pickable` **(** :ref:`RID` area, :ref:`bool` enable **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_area_set_transform` **(** :ref:`RID` area, :ref:`Transform3D` transform **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_add_constant_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_add_constant_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_add_constant_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform3D` transform, :ref:`bool` disabled **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_apply_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_apply_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse, :ref:`Vector3` position **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_apply_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_clear_shapes` **(** :ref:`RID` body **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID[]` | :ref:`_body_get_collision_exceptions` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_collision_layer` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_collision_mask` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_body_get_collision_priority` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_body_get_constant_force` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_body_get_constant_torque` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_body_get_contacts_reported_depth_threshold` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectBodyState3D` | :ref:`_body_get_direct_state` **(** :ref:`RID` body **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_max_contacts_reported` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BodyMode` | :ref:`_body_get_mode` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_object_instance_id` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_shape_count` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_get_space` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_user_flags` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_is_axis_locked` **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_is_continuous_collision_detection_enabled` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_is_omitting_force_integration` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_reset_mass_properties` **(** :ref:`RID` body **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_axis_lock` **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_collision_priority` **(** :ref:`RID` body, :ref:`float` priority **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_constant_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_constant_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_contacts_reported_depth_threshold` **(** :ref:`RID` body, :ref:`float` threshold **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_state_sync_callback` **(** :ref:`RID` body, :ref:`Callable` callable **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_body_set_user_flags` **(** :ref:`RID` body, :ref:`int` flags **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_test_motion` **(** :ref:`RID` body, :ref:`Transform3D` from, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` max_collisions, :ref:`bool` collide_separation_ray, :ref:`bool` recovery_as_collision, PhysicsServer3DExtensionMotionResult* result **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_box_shape_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_capsule_shape_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_concave_polygon_shape_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_cone_twist_joint_get_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_cone_twist_joint_set_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_convex_polygon_shape_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_custom_shape_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_cylinder_shape_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_end_sync` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_finish` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_flush_queries` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_free_rid` **(** :ref:`RID` rid **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_generic_6dof_joint_get_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_generic_6dof_joint_get_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_generic_6dof_joint_set_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_generic_6dof_joint_set_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_process_info` **(** :ref:`ProcessInfo` process_info **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_heightmap_shape_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_hinge_joint_get_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_hinge_joint_get_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_hinge_joint_set_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_hinge_joint_set_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_init` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_flushing_queries` **(** **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_joint_clear` **(** :ref:`RID` joint **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_joint_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_joint_disable_collisions_between_bodies` **(** :ref:`RID` joint, :ref:`bool` disable **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_joint_get_solver_priority` **(** :ref:`RID` joint **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`JointType` | :ref:`_joint_get_type` **(** :ref:`RID` joint **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_joint_is_disabled_collisions_between_bodies` **(** :ref:`RID` joint **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_joint_make_cone_twist` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_joint_make_generic_6dof` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_joint_make_hinge` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` hinge_A, :ref:`RID` body_B, :ref:`Transform3D` hinge_B **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_joint_make_hinge_simple` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Vector3` pivot_A, :ref:`Vector3` axis_A, :ref:`RID` body_B, :ref:`Vector3` pivot_B, :ref:`Vector3` axis_B **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_joint_make_pin` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_joint_make_slider` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_joint_set_solver_priority` **(** :ref:`RID` joint, :ref:`int` priority **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_pin_joint_get_local_a` **(** :ref:`RID` joint **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_pin_joint_get_local_b` **(** :ref:`RID` joint **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_pin_joint_set_local_a` **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_pin_joint_set_local_b` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_separation_ray_shape_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_set_active` **(** :ref:`bool` active **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shape_get_custom_solver_bias` **(** :ref:`RID` shape **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_shape_get_data` **(** :ref:`RID` shape **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shape_get_margin` **(** :ref:`RID` shape **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ShapeType` | :ref:`_shape_get_type` **(** :ref:`RID` shape **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_shape_set_custom_solver_bias` **(** :ref:`RID` shape, :ref:`float` bias **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_shape_set_margin` **(** :ref:`RID` shape, :ref:`float` margin **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_slider_joint_get_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_slider_joint_set_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` body_b **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_soft_body_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`_soft_body_get_bounds` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID[]` | :ref:`_soft_body_get_collision_exceptions` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_soft_body_get_collision_layer` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_soft_body_get_collision_mask` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_damping_coefficient` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_drag_coefficient` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_linear_stiffness` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_soft_body_get_point_global_position` **(** :ref:`RID` body, :ref:`int` point_index **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_pressure_coefficient` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_soft_body_get_simulation_precision` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_soft_body_get_space` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_soft_body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_total_mass` **(** :ref:`RID` body **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_soft_body_is_point_pinned` **(** :ref:`RID` body, :ref:`int` point_index **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_move_point` **(** :ref:`RID` body, :ref:`int` point_index, :ref:`Vector3` global_position **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_pin_point` **(** :ref:`RID` body, :ref:`int` point_index, :ref:`bool` pin **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_remove_all_pinned_points` **(** :ref:`RID` body **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` body_b **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_set_damping_coefficient` **(** :ref:`RID` body, :ref:`float` damping_coefficient **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_set_drag_coefficient` **(** :ref:`RID` body, :ref:`float` drag_coefficient **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_set_linear_stiffness` **(** :ref:`RID` body, :ref:`float` linear_stiffness **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_set_mesh` **(** :ref:`RID` body, :ref:`RID` mesh **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_set_pressure_coefficient` **(** :ref:`RID` body, :ref:`float` pressure_coefficient **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_set_simulation_precision` **(** :ref:`RID` body, :ref:`int` simulation_precision **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` variant **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_set_total_mass` **(** :ref:`RID` body, :ref:`float` total_mass **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_set_transform` **(** :ref:`RID` body, :ref:`Transform3D` transform **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_soft_body_update_rendering_server` **(** :ref:`RID` body, :ref:`PhysicsServer3DRenderingServerHandler` rendering_server_handler **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_space_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_space_get_contact_count` **(** :ref:`RID` space **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`_space_get_contacts` **(** :ref:`RID` space **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectSpaceState3D` | :ref:`_space_get_direct_state` **(** :ref:`RID` space **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_space_is_active` **(** :ref:`RID` space **)** |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_space_set_debug_contacts` **(** :ref:`RID` space, :ref:`int` max_contacts **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_sphere_shape_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_step` **(** :ref:`float` step **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_sync` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_world_boundary_shape_create` **(** **)** |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_test_motion_is_excluding_body` **(** :ref:`RID` body **)** |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_test_motion_is_excluding_object` **(** :ref:`int` object **)** |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -1623,7 +1623,7 @@ void **_body_set_user_flags** **(** :ref:`RID` body, :ref:`int` **_body_test_motion** **(** :ref:`RID` body, :ref:`Transform3D` from, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` max_collisions, :ref:`bool` collide_separation_ray, PhysicsServer3DExtensionMotionResult* result **)** |virtual| |const| +:ref:`bool` **_body_test_motion** **(** :ref:`RID` body, :ref:`Transform3D` from, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` max_collisions, :ref:`bool` collide_separation_ray, :ref:`bool` recovery_as_collision, PhysicsServer3DExtensionMotionResult* result **)** |virtual| |const| .. container:: contribute diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 2035a93fc6e..1a6ad715ff7 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -121,9 +121,7 @@ If ``true``, polygon edges will be anti-aliased. :ref:`Array` **bones** = ``[]`` -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Internal list of :ref:`Bone2D` nodes used by the assigned :ref:`skeleton`. Edited using the Polygon2D editor ("UV" button on the top toolbar). .. rst-class:: classref-item-separator @@ -157,9 +155,7 @@ The polygon's fill color. If ``texture`` is defined, it will be multiplied by th - void **set_internal_vertex_count** **(** :ref:`int` value **)** - :ref:`int` **get_internal_vertex_count** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Number of internal vertices, used for UV mapping. .. rst-class:: classref-item-separator @@ -263,9 +259,7 @@ The list of polygons, in case more than one is being represented. Every individu - void **set_skeleton** **(** :ref:`NodePath` value **)** - :ref:`NodePath` **get_skeleton** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Path to a :ref:`Skeleton2D` node used for skeleton-based deformations of this polygon. If empty or invalid, skeletal deformations will not be used. .. rst-class:: classref-item-separator diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 503a0d9c85d..41517d7e161 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -98,6 +98,8 @@ Methods +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`get_item_icon` **(** :ref:`int` index **)** |const| | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_icon_max_width` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_id` **(** :ref:`int` index **)** |const| | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_indent` **(** :ref:`int` index **)** |const| | @@ -150,6 +152,8 @@ Methods +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_icon` **(** :ref:`int` index, :ref:`Texture2D` icon **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_icon_max_width` **(** :ref:`int` index, :ref:`int` width **)** | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_id` **(** :ref:`int` index, :ref:`int` id **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_indent` **(** :ref:`int` index, :ref:`int` indent **)** | @@ -202,6 +206,8 @@ Theme Properties +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`h_separation` | ``4`` | +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`icon_max_width` | ``0`` | + +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`indent` | ``10`` | +-----------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`item_end_padding` | ``2`` | @@ -678,7 +684,7 @@ Returns the index of the currently focused item. Returns ``-1`` if no item is fo :ref:`Key` **get_item_accelerator** **(** :ref:`int` index **)** |const| -Returns the accelerator of the item at the given ``index``. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The return value is an integer which is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using boolean OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). If no accelerator is defined for the specified ``index``, :ref:`get_item_accelerator` returns ``0`` (corresponding to :ref:`@GlobalScope.KEY_NONE`). +Returns the accelerator of the item at the given ``index``. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The return value is an integer which is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). If no accelerator is defined for the specified ``index``, :ref:`get_item_accelerator` returns ``0`` (corresponding to :ref:`@GlobalScope.KEY_NONE`). .. rst-class:: classref-item-separator @@ -696,6 +702,18 @@ Returns the icon of the item at the given ``index``. ---- +.. _class_PopupMenu_method_get_item_icon_max_width: + +.. rst-class:: classref-method + +:ref:`int` **get_item_icon_max_width** **(** :ref:`int` index **)** |const| + +Returns the maximum allowed width of the icon for the item at the given ``index``. + +.. rst-class:: classref-item-separator + +---- + .. _class_PopupMenu_method_get_item_id: .. rst-class:: classref-method @@ -940,7 +958,7 @@ Passing ``-1`` as the index makes so that no item is focused. void **set_item_accelerator** **(** :ref:`int` index, :ref:`Key` accel **)** -Sets the accelerator of the item at the given ``index``. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. ``accel`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using boolean OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). +Sets the accelerator of the item at the given ``index``. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. ``accel`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). .. rst-class:: classref-item-separator @@ -1020,6 +1038,18 @@ Replaces the :ref:`Texture2D` icon of the item at the given ``i ---- +.. _class_PopupMenu_method_set_item_icon_max_width: + +.. rst-class:: classref-method + +void **set_item_icon_max_width** **(** :ref:`int` index, :ref:`int` width **)** + +Sets the maximum allowed width of the icon for the item at the given ``index``. This limit is applied on top of the default size of the icon and on top of :ref:`icon_max_width`. The height is adjusted according to the icon's ratio. + +.. rst-class:: classref-item-separator + +---- + .. _class_PopupMenu_method_set_item_id: .. rst-class:: classref-method @@ -1279,6 +1309,18 @@ The horizontal space between the item's elements. ---- +.. _class_PopupMenu_theme_constant_icon_max_width: + +.. rst-class:: classref-themeproperty + +:ref:`int` **icon_max_width** = ``0`` + +The maximum allowed width of the item's icon. This limit is applied on top of the default size of the icon, but before the value set with :ref:`set_item_icon_max_width`. The height is adjusted according to the icon's ratio. + +.. rst-class:: classref-item-separator + +---- + .. _class_PopupMenu_theme_constant_indent: .. rst-class:: classref-themeproperty diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 27445c016c9..27e2fbb7f19 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -59,12 +59,12 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/boot_splash/use_filter` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/config/auto_accept_quit` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/config/custom_user_dir_name` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/config/description` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`application/config/features` | | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/config/icon` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/config/macos_native_icon` | ``""`` | @@ -75,6 +75,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/config/project_settings_override` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/config/quit_on_go_back` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/config/use_custom_user_dir` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/config/use_hidden_project_data_directory` | ``true`` | @@ -95,6 +97,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`application/run/low_processor_mode_sleep_usec` | ``6900`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/run/main_loop_type` | ``"SceneTree"`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/run/main_scene` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`application/run/max_fps` | ``0`` | @@ -181,6 +185,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/redundant_await` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debug/gdscript/warnings/redundant_static_unload` | ``1`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/gdscript/warnings/renamed_in_godot_4_hint` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/gdscript/warnings/return_value_discarded` | ``0`` | @@ -339,12 +345,26 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`display/window/size/window_width_override` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`display/window/stretch/aspect` | ``"keep"`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`display/window/stretch/mode` | ``"disabled"`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`display/window/stretch/scale` | ``1.0`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/subwindows/embed_subwindows` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`display/window/vsync/vsync_mode` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`dotnet/project/assembly_name` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`dotnet/project/solution_directory` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editor/export/convert_text_resources_to_binary` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editor/import/reimport_missing_imported_files` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editor/import/use_multiple_threads` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editor/movie_writer/disable_vsync` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`editor/movie_writer/fps` | ``60`` | @@ -365,12 +385,18 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`editor/naming/node_name_num_separator` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editor/naming/scene_name_casing` | ``2`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`editor/run/main_run_args` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`editor/script/search_in_file_extensions` | ``PackedStringArray("gd", "gdshader")`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`editor/script/templates_search_path` | ``"res://script_templates"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editor/version_control/autoload_on_startup` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`editor/version_control/plugin_name` | ``""`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`filesystem/import/blender/enabled` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`filesystem/import/blender/enabled.android` | ``false`` | @@ -385,10 +411,14 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gui/common/snap_controls_to_pixels` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`gui/common/swap_cancel_ok` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`gui/common/text_edit_undo_stack_max_size` | ``1024`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gui/fonts/dynamic_fonts/use_oversampling` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`gui/theme/custom` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`gui/theme/custom_font` | ``""`` | @@ -583,10 +613,6 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`internationalization/locale/test` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`internationalization/locale/translation_remaps` | | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`internationalization/locale/translations` | | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`internationalization/pseudolocalization/double_vowels` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`internationalization/pseudolocalization/expansion_ratio` | ``0.0`` | @@ -607,6 +633,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`internationalization/rendering/force_right_to_left_layout_direction` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`internationalization/rendering/root_node_layout_direction` | ``0`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`internationalization/rendering/text_driver` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`layer_names/2d_navigation/layer_1` | ``""`` | @@ -945,7 +973,7 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`layer_names/3d_render/layer_9` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`memory/limits/message_queue/max_size_kb` | ``4096`` | + | :ref:`int` | :ref:`memory/limits/message_queue/max_size_mb` | ``32`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc` | ``60`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -1307,6 +1335,10 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/shading/overrides/force_vertex_shading.mobile` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/textures/canvas_textures/default_texture_filter` | ``1`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/textures/canvas_textures/default_texture_repeat` | ``0`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/textures/decals/filter` | ``3`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/textures/default_filters/anisotropic_filtering_level` | ``2`` | @@ -1347,6 +1379,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`xr/openxr/reference_space` | ``"1"`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`xr/openxr/startup_alert` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`xr/openxr/submit_depth_buffer` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`xr/openxr/view_configuration` | ``"1"`` | @@ -1479,39 +1513,39 @@ If ``true``, applies linear filtering when scaling the image (recommended for hi ---- -.. _class_ProjectSettings_property_application/config/custom_user_dir_name: +.. _class_ProjectSettings_property_application/config/auto_accept_quit: .. rst-class:: classref-property -:ref:`String` **application/config/custom_user_dir_name** = ``""`` - -This user directory is used for storing persistent data (``user://`` filesystem). If a custom directory name is defined, this name will be appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in :ref:`OS.get_user_data_dir`). +:ref:`bool` **application/config/auto_accept_quit** = ``true`` -The :ref:`application/config/use_custom_user_dir` setting must be enabled for this to take effect. +If ``true``, the application automatically accepts quitting requests. .. rst-class:: classref-item-separator ---- -.. _class_ProjectSettings_property_application/config/description: +.. _class_ProjectSettings_property_application/config/custom_user_dir_name: .. rst-class:: classref-property -:ref:`String` **application/config/description** = ``""`` +:ref:`String` **application/config/custom_user_dir_name** = ``""`` -The project's description, displayed as a tooltip in the Project Manager when hovering the project. +This user directory is used for storing persistent data (``user://`` filesystem). If a custom directory name is defined, this name will be appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in :ref:`OS.get_user_data_dir`). + +The :ref:`application/config/use_custom_user_dir` setting must be enabled for this to take effect. .. rst-class:: classref-item-separator ---- -.. _class_ProjectSettings_property_application/config/features: +.. _class_ProjectSettings_property_application/config/description: .. rst-class:: classref-property -:ref:`PackedStringArray` **application/config/features** +:ref:`String` **application/config/description** = ``""`` -List of internal features associated with the project, like ``Double Precision`` or ``C#``. Not to be confused with feature tags. +The project's description, displayed as a tooltip in the Project Manager when hovering the project. .. rst-class:: classref-item-separator @@ -1581,6 +1615,18 @@ Specifies a file to override project settings. For example: ``user://custom_sett ---- +.. _class_ProjectSettings_property_application/config/quit_on_go_back: + +.. rst-class:: classref-property + +:ref:`bool` **application/config/quit_on_go_back** = ``true`` + +If ``true``, the application quits automatically when navigating back (e.g. using the system "Back" button on Android). + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_application/config/use_custom_user_dir: .. rst-class:: classref-property @@ -1721,6 +1767,18 @@ Amount of sleeping between frames when the low-processor usage mode is enabled ( ---- +.. _class_ProjectSettings_property_application/run/main_loop_type: + +.. rst-class:: classref-property + +:ref:`String` **application/run/main_loop_type** = ``"SceneTree"`` + +The name of the type implementing the engine's main loop. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_application/run/main_scene: .. rst-class:: classref-property @@ -2263,6 +2321,18 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w ---- +.. _class_ProjectSettings_property_debug/gdscript/warnings/redundant_static_unload: + +.. rst-class:: classref-property + +:ref:`int` **debug/gdscript/warnings/redundant_static_unload** = ``1`` + +When set to ``warn`` or ``error``, produces a warning or an error respectively when the ``@static_unload`` annotation is used in a script without any static variables. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/renamed_in_godot_4_hint: .. rst-class:: classref-property @@ -3239,6 +3309,60 @@ On desktop platforms, overrides the game's initial window width. See also :ref:` ---- +.. _class_ProjectSettings_property_display/window/stretch/aspect: + +.. rst-class:: classref-property + +:ref:`String` **display/window/stretch/aspect** = ``"keep"`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_display/window/stretch/mode: + +.. rst-class:: classref-property + +:ref:`String` **display/window/stretch/mode** = ``"disabled"`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_display/window/stretch/scale: + +.. rst-class:: classref-property + +:ref:`float` **display/window/stretch/scale** = ``1.0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_display/window/subwindows/embed_subwindows: + +.. rst-class:: classref-property + +:ref:`bool` **display/window/subwindows/embed_subwindows** = ``true`` + +If ``true`` subwindows are embedded in the main window. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_display/window/vsync/vsync_mode: .. rst-class:: classref-property @@ -3285,6 +3409,44 @@ Changing this value allows setting up a multi-project scenario where there are m ---- +.. _class_ProjectSettings_property_editor/export/convert_text_resources_to_binary: + +.. rst-class:: classref-property + +:ref:`bool` **editor/export/convert_text_resources_to_binary** = ``true`` + +If ``true`` text resources are converted to binary format on export. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_editor/import/reimport_missing_imported_files: + +.. rst-class:: classref-property + +:ref:`bool` **editor/import/reimport_missing_imported_files** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_editor/import/use_multiple_threads: + +.. rst-class:: classref-property + +:ref:`bool` **editor/import/use_multiple_threads** = ``true`` + +If ``true`` importing of resources is run on multiple threads. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_editor/movie_writer/disable_vsync: .. rst-class:: classref-property @@ -3421,6 +3583,18 @@ What to use to separate node name from number. This is mostly an editor setting. ---- +.. _class_ProjectSettings_property_editor/naming/scene_name_casing: + +.. rst-class:: classref-property + +:ref:`int` **editor/naming/scene_name_casing** = ``2`` + +When generating file names from scene root node, set the type of casing in this project. This is mostly an editor setting. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_editor/run/main_run_args: .. rst-class:: classref-property @@ -3465,6 +3639,34 @@ Search path for project-specific script templates. Godot will search for script ---- +.. _class_ProjectSettings_property_editor/version_control/autoload_on_startup: + +.. rst-class:: classref-property + +:ref:`bool` **editor/version_control/autoload_on_startup** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_editor/version_control/plugin_name: + +.. rst-class:: classref-property + +:ref:`String` **editor/version_control/plugin_name** = ``""`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_filesystem/import/blender/enabled: .. rst-class:: classref-property @@ -3553,6 +3755,20 @@ Default value for :ref:`ScrollContainer.scroll_deadzone` **gui/common/snap_controls_to_pixels** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_gui/common/swap_cancel_ok: .. rst-class:: classref-property @@ -3579,6 +3795,20 @@ Maximum undo/redo history size for :ref:`TextEdit` fields. ---- +.. _class_ProjectSettings_property_gui/fonts/dynamic_fonts/use_oversampling: + +.. rst-class:: classref-property + +:ref:`bool` **gui/fonts/dynamic_fonts/use_oversampling** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_gui/theme/custom: .. rst-class:: classref-property @@ -4205,7 +4435,7 @@ macOS specific override for the shortcut to add a caret below every caret. :ref:`Dictionary` **input/ui_text_caret_document_end** -Default :ref:`InputEventAction` to move the text cursor the the end of the text. +Default :ref:`InputEventAction` to move the text cursor to the end of the text. \ **Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. @@ -4889,30 +5119,6 @@ If non-empty, this locale will be used when running the project from the editor. ---- -.. _class_ProjectSettings_property_internationalization/locale/translation_remaps: - -.. rst-class:: classref-property - -:ref:`PackedStringArray` **internationalization/locale/translation_remaps** - -Locale-dependent resource remaps. Edit them in the "Localization" tab of Project Settings editor. - -.. rst-class:: classref-item-separator - ----- - -.. _class_ProjectSettings_property_internationalization/locale/translations: - -.. rst-class:: classref-property - -:ref:`PackedStringArray` **internationalization/locale/translations** - -List of translation files available in the project. Edit them in the "Localization" tab of Project Settings editor. - -.. rst-class:: classref-item-separator - ----- - .. _class_ProjectSettings_property_internationalization/pseudolocalization/double_vowels: .. rst-class:: classref-property @@ -5029,7 +5235,19 @@ If ``true``, enables pseudolocalization for the project. This can be used to spo :ref:`bool` **internationalization/rendering/force_right_to_left_layout_direction** = ``false`` -Force layout direction and text writing direction to RTL for all locales. +Force layout direction and text writing direction to RTL for all controls. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_internationalization/rendering/root_node_layout_direction: + +.. rst-class:: classref-property + +:ref:`int` **internationalization/rendering/root_node_layout_direction** = ``0`` + +Root node default layout direction. .. rst-class:: classref-item-separator @@ -7069,11 +7287,11 @@ Optional name for the 3D render layer 9. If left empty, the layer will display a ---- -.. _class_ProjectSettings_property_memory/limits/message_queue/max_size_kb: +.. _class_ProjectSettings_property_memory/limits/message_queue/max_size_mb: .. rst-class:: classref-property -:ref:`int` **memory/limits/message_queue/max_size_kb** = ``4096`` +:ref:`int` **memory/limits/message_queue/max_size_mb** = ``32`` Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here. @@ -7827,9 +8045,7 @@ The number of fixed iterations per second. This controls how often physics simul :ref:`bool` **rendering/2d/snap/snap_2d_transforms_to_pixel** = ``false`` -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If ``true``, :ref:`CanvasItem` nodes will internally snap to full pixels. Their position can still be sub-pixel, but the decimals will not have effect. .. rst-class:: classref-item-separator @@ -7841,9 +8057,7 @@ The number of fixed iterations per second. This controls how often physics simul :ref:`bool` **rendering/2d/snap/snap_2d_vertices_to_pixel** = ``false`` -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If ``true``, vertices of :ref:`CanvasItem` nodes will snap to full pixels. Only affects the final vertex positions, not the transforms. .. rst-class:: classref-item-separator @@ -9445,6 +9659,30 @@ Lower-end override for :ref:`rendering/shading/overrides/force_vertex_shading` **rendering/textures/canvas_textures/default_texture_filter** = ``1`` + +The default texture filtering mode to use on :ref:`CanvasItem`\ s. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_rendering/textures/canvas_textures/default_texture_repeat: + +.. rst-class:: classref-property + +:ref:`int` **rendering/textures/canvas_textures/default_texture_repeat** = ``0`` + +The default texture repeating mode to use on :ref:`CanvasItem`\ s. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/textures/decals/filter: .. rst-class:: classref-property @@ -9551,7 +9789,7 @@ If ``true``, the texture importer will import VRAM-compressed textures using the :ref:`bool` **rendering/textures/vram_compression/import_s3tc_bptc** -If ``true``, the texture importer will import VRAM-compressed textures using the S3 Texture Compression algorithm (DXT1-5) for lower quality textures and the the BPTC algorithm (BC6H and BC7) for high quality textures. This algorithm is only supported on PC desktop platforms and consoles. +If ``true``, the texture importer will import VRAM-compressed textures using the S3 Texture Compression algorithm (DXT1-5) for lower quality textures and the BPTC algorithm (BC6H and BC7) for high quality textures. This algorithm is only supported on PC desktop platforms and consoles. \ **Note:** Changing this setting does *not* impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the ``.godot/imported/`` folder located inside the project folder then restart the editor (see :ref:`application/config/use_hidden_project_data_directory`). @@ -9654,9 +9892,7 @@ The texture *must* use a lossless compression format so that colors can be match :ref:`int` **threading/worker_pool/max_threads** = ``-1`` -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Maximum number of threads to be used by :ref:`WorkerThreadPool`. Value of ``-1`` means no limit. .. rst-class:: classref-item-separator @@ -9724,6 +9960,18 @@ Specify the default reference space. ---- +.. _class_ProjectSettings_property_xr/openxr/startup_alert: + +.. rst-class:: classref-property + +:ref:`bool` **xr/openxr/startup_alert** = ``true`` + +If ``true``, Godot will display an alert modal when OpenXR initialization fails on startup. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_xr/openxr/submit_depth_buffer: .. rst-class:: classref-property @@ -9773,11 +10021,11 @@ void **add_property_info** **(** :ref:`Dictionary` hint **)** Adds a custom property info to a property. The dictionary must contain: -- ``name``: :ref:`String` (the property's name) +- ``"name"``: :ref:`String` (the property's name) -- ``type``: :ref:`int` (see :ref:`Variant.Type`) +- ``"type"``: :ref:`int` (see :ref:`Variant.Type`) -- optionally ``hint``: :ref:`int` (see :ref:`PropertyHint`) and ``hint_string``: :ref:`String`\ +- optionally ``"hint"``: :ref:`int` (see :ref:`PropertyHint`) and ``"hint_string"``: :ref:`String`\ \ **Example:**\ diff --git a/classes/class_quaternion.rst b/classes/class_quaternion.rst index 6666ffb05b8..b865cd7ce3d 100644 --- a/classes/class_quaternion.rst +++ b/classes/class_quaternion.rst @@ -10,18 +10,18 @@ Quaternion ========== -Quaternion. +A unit quaternion used for representing 3D rotations. .. rst-class:: classref-introduction-group Description ----------- -A unit quaternion used for representing 3D rotations. Quaternions need to be normalized to be used for rotation. +Quaternions are similar to :ref:`Basis`, which implements the matrix representation of rotations. Unlike :ref:`Basis`, which stores rotation, scale, and shearing, quaternions only store rotation. -It is similar to Basis, which implements matrix representation of rotations, and can be parametrized using both an axis-angle pair or Euler angles. Basis stores rotation, scale, and shearing, while Quaternion only stores rotation. +Quaternions can be parametrized using both an axis-angle pair or Euler angles. Due to their compactness and the way they are stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating-point errors. -Due to its compactness and the way it is stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating-point errors. +\ **Note:** Quaternions need to be normalized before being used for rotation. .. rst-class:: classref-introduction-group @@ -269,9 +269,7 @@ Constructs a **Quaternion** as a copy of the given **Quaternion**. :ref:`Quaternion` **Quaternion** **(** :ref:`Vector3` arc_from, :ref:`Vector3` arc_to **)** -.. container:: contribute - - There is currently no description for this constructor. Please help us by :ref:`contributing one `! +Constructs a quaternion representing the shortest arc between two points on the surface of a sphere with a radius of ``1.0``. .. rst-class:: classref-item-separator diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index 1f9a9232c9f..0e57113a8b1 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -12,7 +12,7 @@ RefCounted **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AESContext`, :ref:`AnimationTrackEditPlugin`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRPositionalTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` +**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRPositionalTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` Base class for reference-counted objects. diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index f326a0eb8d0..e38c056cf29 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -64,7 +64,7 @@ Methods +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`compute_pipeline_create` **(** :ref:`RID` shader, :ref:`RDPipelineSpecializationConstant[]` specialization_constants=[] **)** | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`compute_pipeline_is_valid` **(** :ref:`RID` compute_pieline **)** | + | :ref:`bool` | :ref:`compute_pipeline_is_valid` **(** :ref:`RID` compute_pipeline **)** | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RenderingDevice` | :ref:`create_local_device` **(** **)** | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -160,6 +160,8 @@ Methods +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`sampler_create` **(** :ref:`RDSamplerState` state **)** | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`sampler_is_format_supported_for_filter` **(** :ref:`DataFormat` format, :ref:`SamplerFilter` sampler_filter **)** |const| | + +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`screen_get_framebuffer_format` **(** **)** |const| | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`screen_get_height` **(** :ref:`int` screen=0 **)** |const| | @@ -4468,7 +4470,7 @@ void **compute_list_set_push_constant** **(** :ref:`int` compute_list .. rst-class:: classref-method -:ref:`bool` **compute_pipeline_is_valid** **(** :ref:`RID` compute_pieline **)** +:ref:`bool` **compute_pipeline_is_valid** **(** :ref:`RID` compute_pipeline **)** .. container:: contribute @@ -5134,6 +5136,18 @@ void **full_barrier** **(** **)** ---- +.. _class_RenderingDevice_method_sampler_is_format_supported_for_filter: + +.. rst-class:: classref-method + +:ref:`bool` **sampler_is_format_supported_for_filter** **(** :ref:`DataFormat` format, :ref:`SamplerFilter` sampler_filter **)** |const| + +Returns ``true`` if implementation supports using a texture of ``format`` with the given ``sampler_filter``. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingDevice_method_screen_get_framebuffer_format: .. rst-class:: classref-method diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 0d8dd6d9073..f119105cb95 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -115,6 +115,8 @@ Methods +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_msdf_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`float` px_range=1.0, :ref:`float` scale=1.0 **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`canvas_item_add_multiline` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=-1.0 **)** | + +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** | @@ -633,7 +635,7 @@ Methods +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_collision_set_attractor_directionality` **(** :ref:`RID` particles_collision, :ref:`float` amount **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_collision_set_attractor_strength` **(** :ref:`RID` particles_collision, :ref:`float` setrngth **)** | + | void | :ref:`particles_collision_set_attractor_strength` **(** :ref:`RID` particles_collision, :ref:`float` strength **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_collision_set_box_extents` **(** :ref:`RID` particles_collision, :ref:`Vector3` extents **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -857,6 +859,8 @@ Methods +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfoType` type, :ref:`ViewportRenderInfo` info **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`viewport_get_render_target` **(** :ref:`RID` viewport **)** |const| | + +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | @@ -2672,7 +2676,7 @@ enum **ViewportScaling3DMode**: :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_BILINEAR** = ``0`` -Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less then ``1.0`` will result in undersampling while values greater than ``1.0`` will result in supersampling. A value of ``1.0`` disables scaling. +Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will result in undersampling while values greater than ``1.0`` will result in supersampling. A value of ``1.0`` disables scaling. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR: @@ -2680,7 +2684,7 @@ Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_FSR** = ``1`` -Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less then ``1.0`` will be result in the viewport being upscaled using FSR. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. +Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_MAX: @@ -5312,6 +5316,8 @@ Creates a camera attributes object and adds it to the RenderingServer. It can be Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` static method. +This is the internal equivalent of the :ref:`CameraAttributes` resource. + .. rst-class:: classref-item-separator ---- @@ -5400,6 +5406,8 @@ Creates a camera and adds it to the RenderingServer. It can be accessed with the Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` static method. +This is the internal equivalent of the :ref:`Camera3D` node. + .. rst-class:: classref-item-separator ---- @@ -5510,6 +5518,8 @@ Creates a canvas and returns the assigned :ref:`RID`. It can be acces Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` static method. +Canvas has no :ref:`Resource` or :ref:`Node` equivalent. + .. rst-class:: classref-item-separator ---- @@ -5598,6 +5608,18 @@ See also :ref:`CanvasItem.draw_msdf_texture_rect_region` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=-1.0 **)** + +Draws a 2D multiline on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_multiline` and :ref:`CanvasItem.draw_multiline_colors`. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_canvas_item_add_multimesh: .. rst-class:: classref-method @@ -5652,7 +5674,7 @@ Draws a 2D polygon on the :ref:`CanvasItem` pointed to by the void **canvas_item_add_polyline** **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** -Draws a 2D polyline on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_polyline`. +Draws a 2D polyline on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_polyline` and :ref:`CanvasItem.draw_polyline_colors`. .. rst-class:: classref-item-separator @@ -5700,9 +5722,7 @@ Sets a :ref:`Transform2D` that will be used to transform subs void **canvas_item_add_texture_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Draws a 2D textured rectangle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_texture_rect` and :ref:`Texture2D.draw_rect`. .. rst-class:: classref-item-separator @@ -5714,9 +5734,7 @@ void **canvas_item_add_texture_rect** **(** :ref:`RID` item, :ref:`Re void **canvas_item_add_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false, :ref:`bool` clip_uv=true **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Draws the specified region of a 2D textured rectangle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_texture_rect_region` and :ref:`Texture2D.draw_rect_region`. .. rst-class:: classref-item-separator @@ -5754,7 +5772,11 @@ Clears the :ref:`CanvasItem` and removes all commands in it. :ref:`RID` **canvas_item_create** **(** **)** -Creates a new :ref:`CanvasItem` instance and returns its :ref:`RID`. +Creates a canvas item and returns the assigned :ref:`RID`. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_item_*`` RenderingServer functions. + +Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` static method. + +This is the internal equivalent of the :ref:`CanvasItem` node. .. rst-class:: classref-item-separator @@ -5914,9 +5936,7 @@ Sets a new material to the :ref:`CanvasItem`. void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets a color modulation to the :ref:`CanvasItem`. This also affects child canvas items. .. rst-class:: classref-item-separator @@ -5928,9 +5948,7 @@ void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color< void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` parent **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets a parent :ref:`CanvasItem` to the :ref:`CanvasItem`. The item will inherit transform, modulation and visibility from its parent, like :ref:`CanvasItem` nodes in the scene tree. .. rst-class:: classref-item-separator @@ -5942,9 +5960,7 @@ void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` item, :ref:`Color` color **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets a color self-modulation to the :ref:`CanvasItem`. It does not affect the child canvas items. .. rst-class:: classref-item-separator @@ -5956,9 +5972,7 @@ void **canvas_item_set_self_modulate** **(** :ref:`RID` item, :ref:`C void **canvas_item_set_sort_children_by_y** **(** :ref:`RID` item, :ref:`bool` enabled **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Enables or disables Y-sorting of a :ref:`CanvasItem`. .. rst-class:: classref-item-separator @@ -5970,9 +5984,7 @@ void **canvas_item_set_sort_children_by_y** **(** :ref:`RID` item, :r void **canvas_item_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the transform of the :ref:`CanvasItem`. It affects where and how the item will be drawn. Child canvas items' transforms are multiplied by their parent's transform. .. rst-class:: classref-item-separator @@ -6008,9 +6020,9 @@ Sets the rendering visibility layer associated with this :ref:`CanvasItem` item, :ref:`bool` enable, :ref:`Rect2` area, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** -.. container:: contribute +Sets the given :ref:`CanvasItem` as visibility notifier. ``area`` defines the area of detecting visibility. ``enter_callable`` is called when the :ref:`CanvasItem` enters the screen, ``exit_callable`` is called when the :ref:`CanvasItem` exits the screen. If ``enable`` is ``false``, the item will no longer function as notifier. - There is currently no description for this method. Please help us by :ref:`contributing one `! +This method can be used to manually mimic :ref:`VisibleOnScreenNotifier2D`. .. rst-class:: classref-item-separator @@ -6022,9 +6034,7 @@ void **canvas_item_set_visibility_notifier** **(** :ref:`RID` item, : void **canvas_item_set_visible** **(** :ref:`RID` item, :ref:`bool` visible **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the visibility of the :ref:`CanvasItem`. .. rst-class:: classref-item-separator @@ -6098,7 +6108,7 @@ Attaches a light occluder to the canvas. Removes it from its previous canvas. :ref:`RID` **canvas_light_occluder_create** **(** **)** -Creates a light occluder and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_light_ocluder_*`` RenderingServer functions. +Creates a light occluder and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_light_occluder_*`` RenderingServer functions. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` static method. @@ -6480,9 +6490,11 @@ void **canvas_set_shadow_texture_size** **(** :ref:`int` size **)** :ref:`RID` **canvas_texture_create** **(** **)** -.. container:: contribute +Creates a canvas texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_texture_*`` RenderingServer functions. - There is currently no description for this method. Please help us by :ref:`contributing one `! +Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` static method. + +This is the internal equivalent of the :ref:`CanvasTexture` resource. .. rst-class:: classref-item-separator @@ -6522,9 +6534,7 @@ void **canvas_texture_set_shading_parameters** **(** :ref:`RID` canva void **canvas_texture_set_texture_filter** **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureFilter` filter **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the texture filter used by the :ref:`CanvasTexture`. .. rst-class:: classref-item-separator @@ -6536,9 +6546,7 @@ void **canvas_texture_set_texture_filter** **(** :ref:`RID` canvas_te void **canvas_texture_set_texture_repeat** **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureRepeat` repeat **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the texture repeat used by the :ref:`CanvasTexture`. .. rst-class:: classref-item-separator @@ -6564,9 +6572,11 @@ Creates a RenderingDevice that can be used to do draw and compute operations on :ref:`RID` **decal_create** **(** **)** -.. container:: contribute +Creates a decal and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``decal_*`` RenderingServer functions. - There is currently no description for this method. Please help us by :ref:`contributing one `! +Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` static method. + +This is the internal equivalent of the :ref:`Decal` node. .. rst-class:: classref-item-separator @@ -6648,9 +6658,7 @@ void **decal_set_fade** **(** :ref:`RID` decal, :ref:`float` decal, :ref:`Color` color **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the color modulation of the :ref:`Decal`. .. rst-class:: classref-item-separator @@ -6676,9 +6684,7 @@ void **decal_set_normal_fade** **(** :ref:`RID` decal, :ref:`float` decal, :ref:`Vector3` size **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the size of the :ref:`Decal`. .. rst-class:: classref-item-separator @@ -6690,9 +6696,7 @@ void **decal_set_size** **(** :ref:`RID` decal, :ref:`Vector3` decal, :ref:`DecalTexture` type, :ref:`RID` texture **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the texture of the :ref:`Decal`. .. rst-class:: classref-item-separator @@ -6724,6 +6728,8 @@ Once finished with your RID, you will want to free the RID using the RenderingSe To place in a scene, attach this directional light to an instance using :ref:`instance_set_base` using the returned RID. +This is the internal equivalent of the :ref:`DirectionalLight3D` node. + .. rst-class:: classref-item-separator ---- @@ -6780,6 +6786,8 @@ Creates an environment and adds it to the RenderingServer. It can be accessed wi Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` static method. +This is the internal equivalent of the :ref:`Environment` resource. + .. rst-class:: classref-item-separator ---- @@ -7110,7 +7118,11 @@ Sets the resolution of the volumetric fog's froxel buffer. ``size`` is modified :ref:`RID` **fog_volume_create** **(** **)** -Creates a new fog volume and allocates an RID. +Creates a fog volume and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``fog_volume_*`` RenderingServer functions. + +Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` static method. + +This is the internal equivalent of the :ref:`FogVolume` node. .. rst-class:: classref-item-separator @@ -7532,6 +7544,8 @@ Once finished with your RID, you will want to free the RID using the RenderingSe An instance is a way of placing a 3D object in the scenario. Objects like particles, meshes, and reflection probes need to be associated with an instance to be visible in the scenario using :ref:`instance_set_base`. +This is the internal equivalent of the :ref:`VisualInstance3D` node. + .. rst-class:: classref-item-separator ---- @@ -8092,7 +8106,11 @@ If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled :ref:`RID` **lightmap_create** **(** **)** -Creates a new :ref:`LightmapGI` instance. +Creates a lightmap GI and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``lightmap_*`` RenderingServer functions. + +Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` static method. + +This is the internal equivalent of the :ref:`LightmapGI` node. .. rst-class:: classref-item-separator @@ -8258,6 +8276,8 @@ Creates an empty material and adds it to the RenderingServer. It can be accessed Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` static method. +This is the internal equivalent of the :ref:`Material` resource. + .. rst-class:: classref-item-separator ---- @@ -8374,6 +8394,8 @@ Once finished with your RID, you will want to free the RID using the RenderingSe To place in a scene, attach this mesh to an instance using :ref:`instance_set_base` using the returned RID. +This is the internal equivalent of the :ref:`Mesh` resource. + .. rst-class:: classref-item-separator ---- @@ -8664,6 +8686,8 @@ Once finished with your RID, you will want to free the RID using the RenderingSe To place in a scene, attach this multimesh to an instance using :ref:`instance_set_base` using the returned RID. +This is the internal equivalent of the :ref:`MultiMesh` resource. + .. rst-class:: classref-item-separator ---- @@ -8968,7 +8992,7 @@ void **particles_collision_set_attractor_directionality** **(** :ref:`RID` particles_collision, :ref:`float` setrngth **)** +void **particles_collision_set_attractor_strength** **(** :ref:`RID` particles_collision, :ref:`float` strength **)** .. container:: contribute @@ -10463,6 +10487,18 @@ Once finished with your RID, you will want to free the RID using the RenderingSe ---- +.. _class_RenderingServer_method_viewport_get_render_target: + +.. rst-class:: classref-method + +:ref:`RID` **viewport_get_render_target** **(** :ref:`RID` viewport **)** |const| + +Returns the render target for the viewport. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_viewport_get_texture: .. rst-class:: classref-method diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 96d060f0d4f..90e8c5ac906 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -12,7 +12,7 @@ Resource **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraAttributes`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`Font`, :ref:`GDExtension`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`JSON`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRInteractionProfile`, :ref:`OpenXRIPBinding`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VideoStreamPlayback`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` +**Inherited By:** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraAttributes`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`Font`, :ref:`GDExtension`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFCollider`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFPhysicsBody`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`JSON`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRInteractionProfile`, :ref:`OpenXRIPBinding`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VideoStreamPlayback`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` Base class for all resources. diff --git a/classes/class_ribbontrailmesh.rst b/classes/class_ribbontrailmesh.rst index 280eea4f007..13989c05b14 100644 --- a/classes/class_ribbontrailmesh.rst +++ b/classes/class_ribbontrailmesh.rst @@ -12,9 +12,25 @@ RibbonTrailMesh **Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -.. container:: contribute +Represents a straight ribbon-shaped :ref:`PrimitiveMesh` with variable width. - There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Description +----------- + +**RibbonTrailMesh** represents a straight ribbon-shaped mesh with variable width. The ribbon is composed of a number of flat or cross-shaped sections, each with the same :ref:`section_length` and number of :ref:`section_segments`. A :ref:`curve` is sampled along the total length of the ribbon, meaning that the curve determines the size of the ribbon along its length. + +This primitive mesh is usually used for particle trails. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`3D Particle trails <../tutorials/3d/particles/trails>` + +- :doc:`Particle systems (3D) <../tutorials/3d/particles/index>` .. rst-class:: classref-reftable-group @@ -59,7 +75,7 @@ enum **Shape**: :ref:`Shape` **SHAPE_FLAT** = ``0`` - +Gives the mesh a single flat face. .. _class_RibbonTrailMesh_constant_SHAPE_CROSS: @@ -67,7 +83,7 @@ enum **Shape**: :ref:`Shape` **SHAPE_CROSS** = ``1`` - +Gives the mesh two perpendicular flat faces, making a cross shape. .. rst-class:: classref-section-separator @@ -89,9 +105,7 @@ Property Descriptions - void **set_curve** **(** :ref:`Curve` value **)** - :ref:`Curve` **get_curve** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Determines the size of the ribbon along its length. The size of a particular section segment is obtained by multiplying the baseline :ref:`size` by the value of this curve at the given distance. For values smaller than ``0``, the faces will be inverted. .. rst-class:: classref-item-separator @@ -108,9 +122,7 @@ Property Descriptions - void **set_section_length** **(** :ref:`float` value **)** - :ref:`float` **get_section_length** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The length of a section of the ribbon. .. rst-class:: classref-item-separator @@ -127,9 +139,7 @@ Property Descriptions - void **set_section_segments** **(** :ref:`int` value **)** - :ref:`int` **get_section_segments** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The number of segments in a section. The :ref:`curve` is sampled on each segment to determine its size. Higher values result in a more detailed ribbon at the cost of performance. .. rst-class:: classref-item-separator @@ -146,9 +156,7 @@ Property Descriptions - void **set_sections** **(** :ref:`int` value **)** - :ref:`int` **get_sections** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The total number of sections on the ribbon. .. rst-class:: classref-item-separator @@ -165,9 +173,7 @@ Property Descriptions - void **set_shape** **(** :ref:`Shape` value **)** - :ref:`Shape` **get_shape** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Determines the shape of the ribbon. .. rst-class:: classref-item-separator @@ -184,9 +190,7 @@ Property Descriptions - void **set_size** **(** :ref:`float` value **)** - :ref:`float` **get_size** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The baseline size of the ribbon. The size of a particular section segment is obtained by multiplying this size by the value of the :ref:`curve` at the given distance. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 79eb8a8f9b0..4e835f057ff 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -193,7 +193,7 @@ Methods +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_italics` **(** **)** | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_list` **(** :ref:`int` level, :ref:`ListType` type, :ref:`bool` capitalize **)** | + | void | :ref:`push_list` **(** :ref:`int` level, :ref:`ListType` type, :ref:`bool` capitalize, :ref:`String` bullet="•" **)** | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_meta` **(** :ref:`Variant` data **)** | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1444,7 +1444,7 @@ Adds a ``[font]`` tag with a italics font to the tag stack. This is the same as .. rst-class:: classref-method -void **push_list** **(** :ref:`int` level, :ref:`ListType` type, :ref:`bool` capitalize **)** +void **push_list** **(** :ref:`int` level, :ref:`ListType` type, :ref:`bool` capitalize, :ref:`String` bullet="•" **)** Adds ``[ol]`` or ``[ul]`` tag to the tag stack. Multiplies ``level`` by current :ref:`tab_size` to determine new margin length. diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index ce631ad44f8..374abe301dd 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -266,7 +266,7 @@ enum **CenterOfMassMode**: :ref:`CenterOfMassMode` **CENTER_OF_MASS_MODE_AUTO** = ``0`` -In this mode, the body's center of mass is calculated automatically based on its shapes. +In this mode, the body's center of mass is calculated automatically based on its shapes. This assumes that the shapes' origins are also their center of mass. .. _class_RigidBody2D_constant_CENTER_OF_MASS_MODE_CUSTOM: diff --git a/classes/class_rigidbody3d.rst b/classes/class_rigidbody3d.rst index 6d47f40d4ad..40b9a7cd5be 100644 --- a/classes/class_rigidbody3d.rst +++ b/classes/class_rigidbody3d.rst @@ -270,7 +270,7 @@ enum **CenterOfMassMode**: :ref:`CenterOfMassMode` **CENTER_OF_MASS_MODE_AUTO** = ``0`` -In this mode, the body's center of mass is calculated automatically based on its shapes. +In this mode, the body's center of mass is calculated automatically based on its shapes. This assumes that the shapes' origins are also their center of mass. .. _class_RigidBody3D_constant_CENTER_OF_MASS_MODE_CUSTOM: diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 9e4188aa52c..d8e733fdb28 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -288,7 +288,7 @@ Property Descriptions - void **set_auto_accept_quit** **(** :ref:`bool` value **)** - :ref:`bool` **is_auto_accept_quit** **(** **)** -If ``true``, the application automatically accepts quitting. +If ``true``, the application automatically accepts quitting requests. For mobile platforms, see :ref:`quit_on_go_back`. @@ -438,7 +438,7 @@ If ``true``, the **SceneTree** is paused. Doing so will have the following behav - void **set_quit_on_go_back** **(** :ref:`bool` value **)** - :ref:`bool` **is_quit_on_go_back** **(** **)** -If ``true``, the application quits automatically on going back (e.g. on Android). +If ``true``, the application quits automatically when navigating back (e.g. using the system "Back" button on Android). To handle 'Go Back' button when this option is disabled, use :ref:`DisplayServer.WINDOW_EVENT_GO_BACK_REQUEST`. @@ -581,7 +581,7 @@ The timer will be automatically freed after its time elapses. :ref:`Tween` **create_tween** **(** **)** -Creates and returns a new :ref:`Tween`. +Creates and returns a new :ref:`Tween`. The Tween will start automatically on the next process frame or physics frame (depending on :ref:`TweenProcessMode`). .. rst-class:: classref-item-separator diff --git a/classes/class_scriptlanguageextension.rst b/classes/class_scriptlanguageextension.rst index 8cf5669e1da..95626832068 100644 --- a/classes/class_scriptlanguageextension.rst +++ b/classes/class_scriptlanguageextension.rst @@ -253,7 +253,7 @@ The option is local to the location of the code completion query - e.g. a local :ref:`CodeCompletionLocation` **LOCATION_PARENT_MASK** = ``256`` -The option is from the containing class or a parent class, relative to the location of the code completion query. Perform a bitwise OR with the class depth (e.g. 0 for the local class, 1 for the parent, 2 for the grandparent, etc) to store the depth of an option in a the class or a parent class. +The option is from the containing class or a parent class, relative to the location of the code completion query. Perform a bitwise OR with the class depth (e.g. 0 for the local class, 1 for the parent, 2 for the grandparent, etc) to store the depth of an option in the class or a parent class. .. _class_ScriptLanguageExtension_constant_LOCATION_OTHER_USER_CODE: diff --git a/classes/class_shape3d.rst b/classes/class_shape3d.rst index 8d17e3895dd..3caa0b82ed3 100644 --- a/classes/class_shape3d.rst +++ b/classes/class_shape3d.rst @@ -95,7 +95,7 @@ When set to ``0``, the default value from :ref:`ProjectSettings.physics/3d/solve - void **set_margin** **(** :ref:`float` value **)** - :ref:`float` **get_margin** **(** **)** -The collision margin for the shape. Used in Bullet Physics only. +The collision margin for the shape. This is not used in Godot Physics. Collision margins allow collision detection to be more efficient by adding an extra shell around shapes. Collision algorithms are more expensive when objects overlap by more than their margin, so a higher value for margins is better for performance, at the cost of accuracy around edges as it makes them less sharp. diff --git a/classes/class_shapecast2d.rst b/classes/class_shapecast2d.rst index d8d92203d01..fb89a2f2fba 100644 --- a/classes/class_shapecast2d.rst +++ b/classes/class_shapecast2d.rst @@ -21,7 +21,7 @@ Description Shape casting allows to detect collision objects by sweeping the :ref:`shape` along the cast direction determined by :ref:`target_position` (useful for things like beam weapons). -Immediate collision overlaps can be done with the :ref:`target_position` set to ``Vector2(0, 0)`` and by calling :ref:`force_shapecast_update` within the same **physics_frame**. This also helps to overcome some limitations of :ref:`Area2D` when used as a continuous detection area, often requiring waiting a couple of frames before collision information is available to :ref:`Area2D` nodes, and when using the signals creates unnecessary complexity. +Immediate collision overlaps can be done with the :ref:`target_position` set to ``Vector2(0, 0)`` and by calling :ref:`force_shapecast_update` within the same **physics frame**. This also helps to overcome some limitations of :ref:`Area2D` when used as a continuous detection area, often requiring waiting a couple of frames before collision information is available to :ref:`Area2D` nodes, and when using the signals creates unnecessary complexity. The node can detect multiple collision objects, but it's usually used to detect the first collision. diff --git a/classes/class_shapecast3d.rst b/classes/class_shapecast3d.rst index 18fad24083d..f1627d9f108 100644 --- a/classes/class_shapecast3d.rst +++ b/classes/class_shapecast3d.rst @@ -21,7 +21,7 @@ Description Shape casting allows to detect collision objects by sweeping the :ref:`shape` along the cast direction determined by :ref:`target_position` (useful for things like beam weapons). -Immediate collision overlaps can be done with the :ref:`target_position` set to ``Vector3(0, 0, 0)`` and by calling :ref:`force_shapecast_update` within the same **physics_frame**. This also helps to overcome some limitations of :ref:`Area3D` when used as a continuous detection area, often requiring waiting a couple of frames before collision information is available to :ref:`Area3D` nodes, and when using the signals creates unnecessary complexity. +Immediate collision overlaps can be done with the :ref:`target_position` set to ``Vector3(0, 0, 0)`` and by calling :ref:`force_shapecast_update` within the same **physics frame**. This also helps to overcome some limitations of :ref:`Area3D` when used as a continuous detection area, often requiring waiting a couple of frames before collision information is available to :ref:`Area3D` nodes, and when using the signals creates unnecessary complexity. The node can detect multiple collision objects, but it's usually used to detect the first collision. diff --git a/classes/class_skeleton3d.rst b/classes/class_skeleton3d.rst index 8a8c3db4587..9f4fd610294 100644 --- a/classes/class_skeleton3d.rst +++ b/classes/class_skeleton3d.rst @@ -257,7 +257,7 @@ Property Descriptions - void **set_motion_scale** **(** :ref:`float` value **)** - :ref:`float` **get_motion_scale** **(** **)** -Multiplies the position 3D track animation. +Multiplies the 3D position track animation. \ **Note:** Unless this value is ``1.0``, the key value in animation will not match the actual position value. diff --git a/classes/class_skeletonik3d.rst b/classes/class_skeletonik3d.rst index d732e0064fc..9b54d55be1e 100644 --- a/classes/class_skeletonik3d.rst +++ b/classes/class_skeletonik3d.rst @@ -19,7 +19,7 @@ SkeletonIK3D is used to place the end bone of a :ref:`Skeleton3D` bone chain at a certain point in 3D by rotating all bones in the chain accordingly. A typical scenario for IK in games is to place a characters feet on the ground or a characters hands on a currently hold object. SkeletonIK uses FabrikInverseKinematic internally to solve the bone chain and applies the results to the :ref:`Skeleton3D` ``bones_global_pose_override`` property for all affected bones in the chain. If fully applied this overwrites any bone transform from :ref:`Animation`\ s or bone custom poses set by users. The applied amount can be controlled with the ``interpolation`` property. +SkeletonIK3D is used to place the end bone of a :ref:`Skeleton3D` bone chain at a certain point in 3D by rotating all bones in the chain accordingly. A typical scenario for IK in games is to place a characters feet on the ground or a characters hands on a currently hold object. SkeletonIK uses FabrikInverseKinematic internally to solve the bone chain and applies the results to the :ref:`Skeleton3D` ``bones_global_pose_override`` property for all affected bones in the chain. If fully applied this overwrites any bone transform from :ref:`Animation`\ s or bone custom poses set by users. The applied amount can be controlled with the :ref:`interpolation` property. :: diff --git a/classes/class_skeletonmodification2dfabrik.rst b/classes/class_skeletonmodification2dfabrik.rst index 70bb66fa52b..fc253a2e2e0 100644 --- a/classes/class_skeletonmodification2dfabrik.rst +++ b/classes/class_skeletonmodification2dfabrik.rst @@ -21,7 +21,7 @@ Description This :ref:`SkeletonModification2D` uses an algorithm called Forward And Backward Reaching Inverse Kinematics, or FABRIK, to rotate a bone chain so that it reaches a target. -FABRIK works by knowing the positions and lengths of a series of bones, typically called a "bone chain". It first starts by running a forward pass, which places the final bone at the target's position. Then all other bones are moved towards the tip bone, so they stay at the defined bone length away. Then a backwards pass is performed, where the root/first bone in the FABRIK chain is placed back at the origin. then all other bones are moved so they stay at the defined bone length away. This positions the bone chain so that it reaches the target when possible, but all of the bones stay the correct length away from each other. +FABRIK works by knowing the positions and lengths of a series of bones, typically called a "bone chain". It first starts by running a forward pass, which places the final bone at the target's position. Then all other bones are moved towards the tip bone, so they stay at the defined bone length away. Then a backwards pass is performed, where the root/first bone in the FABRIK chain is placed back at the origin. Then all other bones are moved so they stay at the defined bone length away. This positions the bone chain so that it reaches the target when possible, but all of the bones stay the correct length away from each other. Because of how FABRIK works, it often gives more natural results than those seen in :ref:`SkeletonModification2DCCDIK`. FABRIK also supports angle constraints, which are fully taken into account when solving. diff --git a/classes/class_skeletonmodification2dlookat.rst b/classes/class_skeletonmodification2dlookat.rst index 3f1fb091900..7bc27093555 100644 --- a/classes/class_skeletonmodification2dlookat.rst +++ b/classes/class_skeletonmodification2dlookat.rst @@ -104,7 +104,7 @@ The :ref:`Bone2D` node that the modification will operate on. - void **set_bone_index** **(** :ref:`int` value **)** - :ref:`int` **get_bone_index** **(** **)** -The index of the :ref:`Bone2D` node that the modification will oeprate on. +The index of the :ref:`Bone2D` node that the modification will operate on. .. rst-class:: classref-item-separator diff --git a/classes/class_skeletonmodification2dphysicalbones.rst b/classes/class_skeletonmodification2dphysicalbones.rst index 9ee32725320..56c2e2138c1 100644 --- a/classes/class_skeletonmodification2dphysicalbones.rst +++ b/classes/class_skeletonmodification2dphysicalbones.rst @@ -92,7 +92,7 @@ Method Descriptions void **fetch_physical_bones** **(** **)** -Empties the list of :ref:`PhysicalBone2D` nodes and populates it will all :ref:`PhysicalBone2D` nodes that are children of the :ref:`Skeleton2D`. +Empties the list of :ref:`PhysicalBone2D` nodes and populates it with all :ref:`PhysicalBone2D` nodes that are children of the :ref:`Skeleton2D`. .. rst-class:: classref-item-separator diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index b095b6b0631..9aff498a475 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -14,7 +14,7 @@ StaticBody2D **Inherited By:** :ref:`AnimatableBody2D` -Physics body for 2D physics which is static or moves only by script. Useful for floor and walls. +Physics body for 2D physics which is static or moves only by script (without affecting other bodies on its path). Useful for floors and walls. .. rst-class:: classref-introduction-group @@ -27,7 +27,7 @@ A static body is a simple body that doesn't move under physics simulation, i.e. They have extra functionalities to move and affect other bodies: -\ **Static transform change:** Static bodies can be moved by animation or script. In this case, they are just teleported and don't affect other bodies on their path. +\ **Static transform change:** Static bodies *can* be moved by animation or script. In this case, they are just teleported and don't affect other bodies on their path. Use :ref:`AnimatableBody2D` instead of **StaticBody2D** if you need a moving static body that affects other bodies on its path. \ **Constant velocity:** When :ref:`constant_linear_velocity` or :ref:`constant_angular_velocity` is set, static bodies don't move themselves but affect touching bodies as if they were moving. This is useful for simulating conveyor belts or conveyor wheels. diff --git a/classes/class_staticbody3d.rst b/classes/class_staticbody3d.rst index 2671396dd45..1ab6d2d11ce 100644 --- a/classes/class_staticbody3d.rst +++ b/classes/class_staticbody3d.rst @@ -14,7 +14,7 @@ StaticBody3D **Inherited By:** :ref:`AnimatableBody3D` -Physics body for 3D physics which is static or moves only by script. Useful for floor and walls. +Physics body for 3D physics which is static or moves only by script (without affecting other bodies on its path). Useful for floors and walls. .. rst-class:: classref-introduction-group @@ -27,9 +27,9 @@ A static body is a simple body that doesn't move under physics simulation, i.e. They have extra functionalities to move and affect other bodies: -\ *Static transform change:* Static bodies can be moved by animation or script. In this case, they are just teleported and don't affect other bodies on their path. +\ **Static transform change:** Static bodies *can* be moved by animation or script. In this case, they are just teleported and don't affect other bodies on their path. Use :ref:`AnimatableBody3D` instead of **StaticBody3D** if you need a moving static body that affects other bodies on its path. -\ *Constant velocity:* When :ref:`constant_linear_velocity` or :ref:`constant_angular_velocity` is set, static bodies don't move themselves but affect touching bodies as if they were moving. This is useful for simulating conveyor belts or conveyor wheels. +\ **Constant velocity:** When :ref:`constant_linear_velocity` or :ref:`constant_angular_velocity` is set, static bodies don't move themselves but affect touching bodies as if they were moving. This is useful for simulating conveyor belts or conveyor wheels. \ **Warning:** With a non-uniform scale this node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change the size(s) of its collision shape(s) instead. diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index b8296519a57..553c83bec48 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -447,11 +447,11 @@ Puts a zero-terminated ASCII string into the stream prepended by a 32-bit unsign .. code-tab:: gdscript - put_data("Hello world".to_ascii()) + put_data("Hello world".to_ascii_buffer()) .. code-tab:: csharp - PutData("Hello World".ToAscii()); + PutData("Hello World".ToAsciiBuffer()); @@ -522,11 +522,11 @@ Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsig .. code-tab:: gdscript - put_data("Hello world".to_utf8()) + put_data("Hello world".to_utf8_buffer()) .. code-tab:: csharp - PutData("Hello World".ToUtf8()); + PutData("Hello World".ToUtf8Buffer()); diff --git a/classes/class_string.rst b/classes/class_string.rst index 14f73c61833..826605ae96a 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -83,6 +83,8 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars=1 **)** |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** |const| | @@ -105,6 +107,8 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hash` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`hex_decode` **(** **)** |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hex_to_int` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`humanize_size` **(** :ref:`int` size **)** |static| | @@ -237,6 +241,8 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`to_utf8_buffer` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_wchar_buffer` **(** **)** |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`trim_prefix` **(** :ref:`String` prefix **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`trim_suffix` **(** :ref:`String` suffix **)** |const| | @@ -569,6 +575,18 @@ Returns ``true`` if the string ends with the given ``text``. See also :ref:`begi ---- +.. _class_String_method_erase: + +.. rst-class:: classref-method + +:ref:`String` **erase** **(** :ref:`int` position, :ref:`int` chars=1 **)** |const| + +Returns a string with ``chars`` characters erased starting from ``position``. If ``chars`` goes beyond the string's length given the specified ``position``, fewer characters will be erased from the returned string. Returns an empty string if either ``position`` or ``chars`` is negative. Returns the original string unmodified if ``chars`` is ``0``. + +.. rst-class:: classref-item-separator + +---- + .. _class_String_method_find: .. rst-class:: classref-method @@ -779,6 +797,35 @@ Returns the 32-bit hash value representing the string's contents. \ **Note:** Strings with equal hash values are *not* guaranteed to be the same, as a result of hash collisions. On the countrary, strings with different hash values are guaranteed to be different. +.. rst-class:: classref-item-separator + +---- + +.. _class_String_method_hex_decode: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **hex_decode** **(** **)** |const| + +Decodes a hexadecimal string as a :ref:`PackedByteArray`. + + +.. tabs:: + + .. code-tab:: gdscript + + var text = "hello world" + var encoded = text.to_utf8_buffer().hex_encode() # outputs "68656c6c6f20776f726c64" + print(buf.hex_decode().get_string_from_utf8()) + + .. code-tab:: csharp + + var text = "hello world"; + var encoded = text.ToUtf8Buffer().HexEncode(); # outputs "68656c6c6f20776f726c64" + GD.Print(buf.HexDecode().GetStringFromUtf8()); + + + .. rst-class:: classref-item-separator ---- @@ -1826,6 +1873,18 @@ Converts the string to a `UTF-8 `__ encoded ---- +.. _class_String_method_to_wchar_buffer: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **to_wchar_buffer** **(** **)** |const| + +Converts the string to a `wide character `__ (``wchar_t``, UTF-16 on Windows, UTF-32 on other platforms) encoded :ref:`PackedByteArray`. + +.. rst-class:: classref-item-separator + +---- + .. _class_String_method_trim_prefix: .. rst-class:: classref-method @@ -1868,7 +1927,7 @@ Returns the character code at position ``at``. :ref:`String` **uri_decode** **(** **)** |const| -Decodes the string from its URL-encoded format. This method is meant to properly decode the parameters in a URL when receiving an HTTP request. +Decodes the string from its URL-encoded format. This method is meant to properly decode the parameters in a URL when receiving an HTTP request. See also :ref:`uri_encode`. .. tabs:: @@ -1895,7 +1954,7 @@ Decodes the string from its URL-encoded format. This method is meant to properly :ref:`String` **uri_encode** **(** **)** |const| -Encodes the string to URL-friendly format. This method is meant to properly encode the parameters in a URL when sending an HTTP request. +Encodes the string to URL-friendly format. This method is meant to properly encode the parameters in a URL when sending an HTTP request. See also :ref:`uri_decode`. .. tabs:: diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst index cf55f2f694d..70eb6bb2e64 100644 --- a/classes/class_stringname.rst +++ b/classes/class_stringname.rst @@ -76,6 +76,8 @@ Methods +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** |const| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars=1 **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** |const| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** |const| | @@ -98,6 +100,8 @@ Methods +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hash` **(** **)** |const| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`hex_decode` **(** **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hex_to_int` **(** **)** |const| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`indent` **(** :ref:`String` prefix **)** |const| | @@ -220,6 +224,8 @@ Methods +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`to_utf8_buffer` **(** **)** |const| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_wchar_buffer` **(** **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`trim_prefix` **(** :ref:`String` prefix **)** |const| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`trim_suffix` **(** :ref:`String` suffix **)** |const| | @@ -523,6 +529,18 @@ Returns ``true`` if the string ends with the given ``text``. See also :ref:`begi ---- +.. _class_StringName_method_erase: + +.. rst-class:: classref-method + +:ref:`String` **erase** **(** :ref:`int` position, :ref:`int` chars=1 **)** |const| + +Returns a string with ``chars`` characters erased starting from ``position``. If ``chars`` goes beyond the string's length given the specified ``position``, fewer characters will be erased from the returned string. Returns an empty string if either ``position`` or ``chars`` is negative. Returns the original string unmodified if ``chars`` is ``0``. + +.. rst-class:: classref-item-separator + +---- + .. _class_StringName_method_find: .. rst-class:: classref-method @@ -733,6 +751,35 @@ Returns the 32-bit hash value representing the string's contents. \ **Note:** Strings with equal hash values are *not* guaranteed to be the same, as a result of hash collisions. On the countrary, strings with different hash values are guaranteed to be different. +.. rst-class:: classref-item-separator + +---- + +.. _class_StringName_method_hex_decode: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **hex_decode** **(** **)** |const| + +Decodes a hexadecimal string as a :ref:`PackedByteArray`. + + +.. tabs:: + + .. code-tab:: gdscript + + var text = "hello world" + var encoded = text.to_utf8_buffer().hex_encode() # outputs "68656c6c6f20776f726c64" + print(buf.hex_decode().get_string_from_utf8()) + + .. code-tab:: csharp + + var text = "hello world"; + var encoded = text.ToUtf8Buffer().HexEncode(); # outputs "68656c6c6f20776f726c64" + GD.Print(buf.HexDecode().GetStringFromUtf8()); + + + .. rst-class:: classref-item-separator ---- @@ -1669,6 +1716,18 @@ Converts the string to a `UTF-8 `__ encoded ---- +.. _class_StringName_method_to_wchar_buffer: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **to_wchar_buffer** **(** **)** |const| + +Converts the string to a `wide character `__ (``wchar_t``, UTF-16 on Windows, UTF-32 on other platforms) encoded :ref:`PackedByteArray`. + +.. rst-class:: classref-item-separator + +---- + .. _class_StringName_method_trim_prefix: .. rst-class:: classref-method diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index f20a42c6ec5..3e673688d8e 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -57,7 +57,7 @@ Properties +-------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`bool` | :ref:`anti_aliasing` | ``true`` | +-------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+ - | :ref:`float` | :ref:`anti_aliasing_size` | ``0.625`` | + | :ref:`float` | :ref:`anti_aliasing_size` | ``1.0`` | +-------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+ | :ref:`Color` | :ref:`bg_color` | ``Color(0.6, 0.6, 0.6, 1)`` | +-------------------------------+-------------------------------------------------------------------------------------------+-----------------------------+ @@ -164,14 +164,16 @@ Antialiasing draws a small ring around the edges, which fades to transparency. A .. rst-class:: classref-property -:ref:`float` **anti_aliasing_size** = ``0.625`` +:ref:`float` **anti_aliasing_size** = ``1.0`` .. rst-class:: classref-property-setget - void **set_aa_size** **(** :ref:`float` value **)** - :ref:`float` **get_aa_size** **(** **)** -This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. +This changes the size of the antialiasing effect. ``1.0`` is recommended for an optimal result at 100% scale, identical to how rounded rectangles are rendered in web browsers and most vector drawing software. + +\ **Note:** Higher values may produce a blur effect but can also create undesired artifacts on small boxes with large-radius corners. .. rst-class:: classref-item-separator diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 515fd8c7770..e6aeda1509e 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -611,6 +611,8 @@ void **set_smooth_group** **(** :ref:`int` index **)** Specifies the smooth group to use for the *next* vertex. If this is never called, all vertices will have the default smooth group of ``0`` and will be smoothed with adjacent vertices of the same group. To produce a mesh with flat normals, set the smooth group to ``-1``. +\ **Note:** This function actually takes an ``uint32_t``, so C# users should use ``uint32.MaxValue`` instead of ``-1`` to produce a mesh with flat normals. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_syntaxhighlighter.rst b/classes/class_syntaxhighlighter.rst index 1f356b8be67..0c6c324b7d6 100644 --- a/classes/class_syntaxhighlighter.rst +++ b/classes/class_syntaxhighlighter.rst @@ -46,7 +46,7 @@ Methods +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_line_syntax_highlighting` **(** :ref:`int` line **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextEdit` | :ref:`get_text_edit` **(** **)** | + | :ref:`TextEdit` | :ref:`get_text_edit` **(** **)** |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_cache` **(** **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -145,7 +145,7 @@ This will color columns 0-4 red, and columns 5-eol in green. .. rst-class:: classref-method -:ref:`TextEdit` **get_text_edit** **(** **)** +:ref:`TextEdit` **get_text_edit** **(** **)** |const| Returns the associated :ref:`TextEdit` node. diff --git a/classes/class_tabbar.rst b/classes/class_tabbar.rst index b60d0d07b48..999e57553a8 100644 --- a/classes/class_tabbar.rst +++ b/classes/class_tabbar.rst @@ -76,10 +76,14 @@ Methods +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** |const| | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tab_icon_max_width` **(** :ref:`int` tab_idx **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_idx_at_point` **(** :ref:`Vector2` point **)** |const| | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tab_language` **(** :ref:`int` tab_idx **)** |const| | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_tab_metadata` **(** :ref:`int` tab_idx **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_offset` **(** **)** |const| | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** |const| | @@ -104,8 +108,12 @@ Methods +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tab_icon_max_width` **(** :ref:`int` tab_idx, :ref:`int` width **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_language` **(** :ref:`int` tab_idx, :ref:`String` language **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tab_metadata` **(** :ref:`int` tab_idx, :ref:`Variant` metadata **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_text_direction` **(** :ref:`int` tab_idx, :ref:`TextDirection` direction **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | @@ -124,6 +132,8 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.875, 0.875, 0.875, 0.5)`` | +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`font_hovered_color` | ``Color(0.95, 0.95, 0.95, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_selected_color` | ``Color(0.95, 0.95, 0.95, 1)`` | @@ -132,6 +142,8 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`h_separation` | ``4`` | +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`int` | :ref:`icon_max_width` | ``0`` | + +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`outline_size` | ``0`` | +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Font` | :ref:`font` | | @@ -156,6 +168,8 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`tab_disabled` | | +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`tab_hovered` | | + +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`tab_selected` | | +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`tab_unselected` | | @@ -454,7 +468,7 @@ Sets the maximum width which all tabs should be limited to. Unlimited if set to - void **set_scroll_to_selected** **(** :ref:`bool` value **)** - :ref:`bool` **get_scroll_to_selected** **(** **)** -If ``true``, the tab offset will be changed to keep the the currently selected tab visible. +If ``true``, the tab offset will be changed to keep the currently selected tab visible. .. rst-class:: classref-item-separator @@ -635,7 +649,7 @@ Returns the previously active tab index. :ref:`Texture2D` **get_tab_button_icon** **(** :ref:`int` tab_idx **)** |const| -Returns the :ref:`Texture2D` for the right button of the tab at index ``tab_idx`` or ``null`` if the button has no :ref:`Texture2D`. +Returns the icon for the right button of the tab at index ``tab_idx`` or ``null`` if the right button has no icon. .. rst-class:: classref-item-separator @@ -647,7 +661,19 @@ Returns the :ref:`Texture2D` for the right button of the tab at :ref:`Texture2D` **get_tab_icon** **(** :ref:`int` tab_idx **)** |const| -Returns the :ref:`Texture2D` for the tab at index ``tab_idx`` or ``null`` if the tab has no :ref:`Texture2D`. +Returns the icon for the tab at index ``tab_idx`` or ``null`` if the tab has no icon. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TabBar_method_get_tab_icon_max_width: + +.. rst-class:: classref-method + +:ref:`int` **get_tab_icon_max_width** **(** :ref:`int` tab_idx **)** |const| + +Returns the maximum allowed width of the icon for the tab at index ``tab_idx``. .. rst-class:: classref-item-separator @@ -677,6 +703,18 @@ Returns tab title language code. ---- +.. _class_TabBar_method_get_tab_metadata: + +.. rst-class:: classref-method + +:ref:`Variant` **get_tab_metadata** **(** :ref:`int` tab_idx **)** |const| + +Returns the metadata value set to the tab at index ``tab_idx`` using :ref:`set_tab_metadata`. If no metadata was previously set, returns ``null`` by default. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabBar_method_get_tab_offset: .. rst-class:: classref-method @@ -821,6 +859,18 @@ Sets an ``icon`` for the tab at index ``tab_idx``. ---- +.. _class_TabBar_method_set_tab_icon_max_width: + +.. rst-class:: classref-method + +void **set_tab_icon_max_width** **(** :ref:`int` tab_idx, :ref:`int` width **)** + +Sets the maximum allowed width of the icon for the tab at index ``tab_idx``. This limit is applied on top of the default size of the icon and on top of :ref:`icon_max_width`. The height is adjusted according to the icon's ratio. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabBar_method_set_tab_language: .. rst-class:: classref-method @@ -833,6 +883,18 @@ Sets language code of tab title used for line-breaking and text shaping algorith ---- +.. _class_TabBar_method_set_tab_metadata: + +.. rst-class:: classref-method + +void **set_tab_metadata** **(** :ref:`int` tab_idx, :ref:`Variant` metadata **)** + +Sets the metadata value for the tab at index ``tab_idx``, which can be retrieved later using :ref:`get_tab_metadata`. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabBar_method_set_tab_text_direction: .. rst-class:: classref-method @@ -886,6 +948,18 @@ Font color of disabled tabs. ---- +.. _class_TabBar_theme_color_font_hovered_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **font_hovered_color** = ``Color(0.95, 0.95, 0.95, 1)`` + +Font color of the currently hovered tab. Does not apply to the selected tab. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabBar_theme_color_font_outline_color: .. rst-class:: classref-themeproperty @@ -934,6 +1008,18 @@ The horizontal separation between the elements inside tabs. ---- +.. _class_TabBar_theme_constant_icon_max_width: + +.. rst-class:: classref-themeproperty + +:ref:`int` **icon_max_width** = ``0`` + +The maximum allowed width of the tab's icon. This limit is applied on top of the default size of the icon, but before the value set with :ref:`set_tab_icon_max_width`. The height is adjusted according to the icon's ratio. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabBar_theme_constant_outline_size: .. rst-class:: classref-themeproperty @@ -1080,6 +1166,18 @@ The style of disabled tabs. ---- +.. _class_TabBar_theme_style_tab_hovered: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **tab_hovered** + +The style of the currently hovered tab. Does not apply to the selected tab. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabBar_theme_style_tab_selected: .. rst-class:: classref-themeproperty diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index d1c9bafa9cd..93ef6a925ff 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -85,6 +85,8 @@ Methods +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_idx_from_control` **(** :ref:`Control` control **)** |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_tab_metadata` **(** :ref:`int` tab_idx **)** |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_tab_disabled` **(** :ref:`int` tab_idx **)** |const| | @@ -101,6 +103,8 @@ Methods +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tab_metadata` **(** :ref:`int` tab_idx, :ref:`Variant` metadata **)** | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -117,12 +121,16 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.875, 0.875, 0.875, 0.5)`` | +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`Color` | :ref:`font_hovered_color` | ``Color(0.95, 0.95, 0.95, 1)`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_selected_color` | ``Color(0.95, 0.95, 0.95, 1)`` | +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_unselected_color` | ``Color(0.7, 0.7, 0.7, 1)`` | +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`int` | :ref:`icon_max_width` | ``0`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`icon_separation` | ``4`` | +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`outline_size` | ``0`` | @@ -151,6 +159,8 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`tab_disabled` | | +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`tab_hovered` | | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`tab_selected` | | +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`tab_unselected` | | @@ -167,6 +177,18 @@ Theme Properties Signals ------- +.. _class_TabContainer_signal_active_tab_rearranged: + +.. rst-class:: classref-signal + +**active_tab_rearranged** **(** :ref:`int` idx_to **)** + +Emitted when the active tab is rearranged via mouse drag. See :ref:`drag_to_rearrange_enabled`. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_signal_pre_popup_pressed: .. rst-class:: classref-signal @@ -203,6 +225,30 @@ Emitted when switching to another tab. ---- +.. _class_TabContainer_signal_tab_clicked: + +.. rst-class:: classref-signal + +**tab_clicked** **(** :ref:`int` tab **)** + +Emitted when a tab is clicked, even if it is the current tab. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TabContainer_signal_tab_hovered: + +.. rst-class:: classref-signal + +**tab_hovered** **(** :ref:`int` tab **)** + +Emitted when a tab is hovered by the mouse. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_signal_tab_selected: .. rst-class:: classref-signal @@ -473,6 +519,18 @@ Returns the index of the tab tied to the given ``control``. The control must be ---- +.. _class_TabContainer_method_get_tab_metadata: + +.. rst-class:: classref-method + +:ref:`Variant` **get_tab_metadata** **(** :ref:`int` tab_idx **)** |const| + +Returns the metadata value set to the tab at index ``tab_idx`` using :ref:`set_tab_metadata`. If no metadata was previously set, returns ``null`` by default. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_method_get_tab_title: .. rst-class:: classref-method @@ -569,6 +627,18 @@ Sets an icon for the tab at index ``tab_idx``. ---- +.. _class_TabContainer_method_set_tab_metadata: + +.. rst-class:: classref-method + +void **set_tab_metadata** **(** :ref:`int` tab_idx, :ref:`Variant` metadata **)** + +Sets the metadata value for the tab at index ``tab_idx``, which can be retrieved later using :ref:`get_tab_metadata`. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_method_set_tab_title: .. rst-class:: classref-method @@ -610,6 +680,18 @@ Font color of disabled tabs. ---- +.. _class_TabContainer_theme_color_font_hovered_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **font_hovered_color** = ``Color(0.95, 0.95, 0.95, 1)`` + +Font color of the currently hovered tab. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_theme_color_font_outline_color: .. rst-class:: classref-themeproperty @@ -646,6 +728,18 @@ Font color of the other, unselected tabs. ---- +.. _class_TabContainer_theme_constant_icon_max_width: + +.. rst-class:: classref-themeproperty + +:ref:`int` **icon_max_width** = ``0`` + +The maximum allowed width of the tab's icon. This limit is applied on top of the default size of the icon, but before the value set with :ref:`TabBar.set_tab_icon_max_width`. The height is adjusted according to the icon's ratio. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_theme_constant_icon_separation: .. rst-class:: classref-themeproperty @@ -818,6 +912,18 @@ The style of disabled tabs. ---- +.. _class_TabContainer_theme_style_tab_hovered: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **tab_hovered** + +The style of the currently hovered tab. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_theme_style_tab_selected: .. rst-class:: classref-themeproperty diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 369492eaaf7..00187d1d026 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -40,6 +40,8 @@ Properties +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`caret_blink_interval` | ``0.65`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`caret_draw_when_editable_disabled` | ``false`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`caret_mid_grapheme` | ``true`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`caret_move_on_right_click` | ``true`` | @@ -959,7 +961,7 @@ Select whole words as if the user double clicked. :ref:`SelectionMode` **SELECTION_MODE_LINE** = ``4`` -Select whole lines as if the user tripped clicked. +Select whole lines as if the user triple clicked. .. rst-class:: classref-item-separator @@ -1041,7 +1043,7 @@ Property Descriptions - void **set_caret_blink_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_caret_blink_enabled** **(** **)** -Sets if the caret should blink. +If ``true``, makes the caret blink. .. rst-class:: classref-item-separator @@ -1058,7 +1060,24 @@ Sets if the caret should blink. - void **set_caret_blink_interval** **(** :ref:`float` value **)** - :ref:`float` **get_caret_blink_interval** **(** **)** -Duration (in seconds) of a caret's blinking cycle. +The interval at which the caret blinks (in seconds). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextEdit_property_caret_draw_when_editable_disabled: + +.. rst-class:: classref-property + +:ref:`bool` **caret_draw_when_editable_disabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_draw_caret_when_editable_disabled** **(** :ref:`bool` value **)** +- :ref:`bool` **is_drawing_caret_when_editable_disabled** **(** **)** + +If ``true``, caret will be visible when :ref:`editable` is disabled. .. rst-class:: classref-item-separator @@ -2453,7 +2472,7 @@ Returns the scroll position for ``wrap_index`` of ``line``. :ref:`String` **get_selected_text** **(** :ref:`int` caret_index=-1 **)** -Returns the text inside the selection. +Returns the text inside the selection of a caret, or all the carets if ``caret_index`` is its default value ``-1``. .. rst-class:: classref-item-separator diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index 49479dba4a9..49c39146c02 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -54,6 +54,8 @@ Methods +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`font_get_ascent` **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_char_from_glyph_index` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph_index **)** |const| | + +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`font_get_descent` **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`font_get_embolden` **(** :ref:`RID` font_rid **)** |const| | @@ -1006,6 +1008,14 @@ Grapheme is connected to the previous grapheme. Breaking line before this graphe It is safe to insert a U+0640 before this grapheme for elongation. +.. _class_TextServer_constant_GRAPHEME_IS_EMBEDDED_OBJECT: + +.. rst-class:: classref-enumeration-constant + +:ref:`GraphemeFlag` **GRAPHEME_IS_EMBEDDED_OBJECT** = ``4096`` + +Grapheme is an object replacement character for the embedded object. + .. rst-class:: classref-item-separator ---- @@ -1579,6 +1589,18 @@ Returns the font ascent (number of pixels above the baseline). ---- +.. _class_TextServer_method_font_get_char_from_glyph_index: + +.. rst-class:: classref-method + +:ref:`int` **font_get_char_from_glyph_index** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph_index **)** |const| + +Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_index`` is invalid. See :ref:`font_get_glyph_index`. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_font_get_descent: .. rst-class:: classref-method @@ -1701,7 +1723,7 @@ Returns outline contours of the glyph as a ``Dictionary`` with the following con :ref:`int` **font_get_glyph_index** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` char, :ref:`int` variation_selector **)** |const| -Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``. +Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``. See :ref:`font_get_char_from_glyph_index`. .. rst-class:: classref-item-separator @@ -2929,7 +2951,7 @@ Returns ``true`` if locale is right-to-left. :ref:`bool` **is_valid_identifier** **(** :ref:`String` string **)** |const| -Returns ``true`` is ``string`` is a valid identifier. +Returns ``true`` if ``string`` is a valid identifier. If the text server supports the :ref:`FEATURE_UNICODE_IDENTIFIERS` feature, a valid identifier must: @@ -3129,7 +3151,7 @@ Draw the outline of the shaped text into a canvas item at a given position, with :ref:`float` **shaped_text_fit_to_width** **(** :ref:`RID` shaped, :ref:`float` width, :ref:`JustificationFlag` jst_flags=3 **)** -Adjusts text with to fit to specified width, returns new text width. +Adjusts text width to fit to specified width, returns new text width. .. rst-class:: classref-item-separator diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index a7f0a026c25..747df3fb640 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -56,6 +56,8 @@ Methods +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_font_get_ascent` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_char_from_glyph_index` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph_index **)** |virtual| |const| | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_font_get_descent` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_font_get_embolden` **(** :ref:`RID` font_rid **)** |virtual| |const| | @@ -598,6 +600,20 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI ---- +.. _class_TextServerExtension_method__font_get_char_from_glyph_index: + +.. rst-class:: classref-method + +:ref:`int` **_font_get_char_from_glyph_index** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph_index **)** |virtual| |const| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_method__font_get_descent: .. rst-class:: classref-method diff --git a/classes/class_texture3d.rst b/classes/class_texture3d.rst index 5371f04ff14..508881bc162 100644 --- a/classes/class_texture3d.rst +++ b/classes/class_texture3d.rst @@ -12,7 +12,7 @@ Texture3D **Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`CompressedTexture3D`, :ref:`ImageTexture3D`, :ref:`PlaceholderTexture3D` +**Inherited By:** :ref:`CompressedTexture3D`, :ref:`ImageTexture3D`, :ref:`NoiseTexture3D`, :ref:`PlaceholderTexture3D` Base class for 3-dimensionnal textures. diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 4f0db755a3e..4ee057d8bb6 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -21,7 +21,7 @@ Base class for texture types which contain the data of multiple :ref:`Image`. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. See also :ref:`Texture3D`. +Base class for :ref:`ImageTextureLayered` and :ref:`CompressedTextureLayered`. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. See also :ref:`Texture3D`. Data is set on a per-layer basis. For :ref:`Texture2DArray`\ s, the layer specifies the array layer. @@ -135,7 +135,7 @@ Called when the **TextureLayered**'s format is queried. :ref:`int` **_get_height** **(** **)** |virtual| |const| -Called when the the **TextureLayered**'s height is queried. +Called when the **TextureLayered**'s height is queried. .. rst-class:: classref-item-separator diff --git a/classes/class_theme.rst b/classes/class_theme.rst index e67084ecf20..0e6182e14d8 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -704,7 +704,7 @@ Returns a list of all unique theme type names for :ref:`StyleBox Returns the theme property of ``data_type`` defined by ``name`` and ``theme_type``, if it exists. -Returns the engine fallback icon value if the property doesn't exist (see :ref:`ThemeDB`). Use :ref:`has_theme_item` to check for existence. +Returns the engine fallback value if the property doesn't exist (see :ref:`ThemeDB`). Use :ref:`has_theme_item` to check for existence. \ **Note:** This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic. diff --git a/classes/class_thread.rst b/classes/class_thread.rst index da9c11b6c67..8c01342da07 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -108,7 +108,7 @@ Method Descriptions :ref:`String` **get_id** **(** **)** |const| -Returns the current **Thread**'s ID, uniquely identifying it among all threads. If the **Thread** is not running this returns an empty string. +Returns the current **Thread**'s ID, uniquely identifying it among all threads. If the **Thread** has not started running or if :ref:`wait_to_finish` has been called, this returns an empty string. .. rst-class:: classref-item-separator @@ -120,7 +120,7 @@ Returns the current **Thread**'s ID, uniquely identifying it among all threads. :ref:`bool` **is_alive** **(** **)** |const| -Returns ``true`` if this **Thread** is currently running. This is useful for determining if :ref:`wait_to_finish` can be called without blocking the calling thread. +Returns ``true`` if this **Thread** is currently running the provided function. This is useful for determining if :ref:`wait_to_finish` can be called without blocking the calling thread. To check if a **Thread** is joinable, use :ref:`is_started`. diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 925b704a01b..098c354ff7e 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -95,6 +95,8 @@ Methods +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`get_coords_for_body_rid` **(** :ref:`RID` body **)** | +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_layer_for_body_rid` **(** :ref:`RID` body **)** | + +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_layer_modulate` **(** :ref:`int` layer **)** |const| | +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_layer_name` **(** :ref:`int` layer **)** |const| | @@ -251,7 +253,7 @@ The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this If enabled, the TileMap will see its collisions synced to the physics tick and change its collision type from static to kinematic. This is required to create TileMap-based moving platform. -\ **Note:** Enabling ``collision_animatable`` may have a small performance impact, only do it if the TileMap is moving and has colliding tiles. +\ **Note:** Enabling :ref:`collision_animatable` may have a small performance impact, only do it if the TileMap is moving and has colliding tiles. .. rst-class:: classref-item-separator @@ -495,6 +497,18 @@ Returns the coordinates of the tile for given physics body RID. Such RID can be ---- +.. _class_TileMap_method_get_layer_for_body_rid: + +.. rst-class:: classref-method + +:ref:`int` **get_layer_for_body_rid** **(** :ref:`RID` body **)** + +Returns the tilemap layer of the tile for given physics body RID. Such RID can be retrieved from :ref:`KinematicCollision2D.get_collider_rid`, when colliding with a tile. + +.. rst-class:: classref-item-separator + +---- + .. _class_TileMap_method_get_layer_modulate: .. rst-class:: classref-method @@ -763,7 +777,7 @@ Update all the cells in the ``cells`` coordinates array so that they use the giv If ``ignore_empty_terrains`` is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. -\ **Note:** To work correctly, ``set_cells_terrain_connect`` requires the TileMap's TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results. +\ **Note:** To work correctly, this method requires the TileMap's TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results. .. rst-class:: classref-item-separator @@ -779,7 +793,7 @@ Update all the cells in the ``path`` coordinates array so that they use the give If ``ignore_empty_terrains`` is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. -\ **Note:** To work correctly, ``set_cells_terrain_path`` requires the TileMap's TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results. +\ **Note:** To work correctly, this method requires the TileMap's TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results. .. rst-class:: classref-item-separator diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index bb41686c5a3..4c23f8f9d6b 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -712,7 +712,7 @@ Physics layers allow assigning collision polygons to atlas tiles. Adds a :ref:`TileSetSource` to the TileSet. If ``atlas_source_id_override`` 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. +The function returns the added source ID or -1 if the source could not be added. .. rst-class:: classref-item-separator @@ -860,7 +860,7 @@ Returns whether or not the specified navigation layer of the TileSet navigation :ref:`int` **get_navigation_layer_layers** **(** :ref:`int` layer_index **)** |const| -Returns the navigation layers (as in the Navigation server) of the gives TileSet navigation layer. +Returns the navigation layers (as in the Navigation server) of the given TileSet navigation layer. .. rst-class:: classref-item-separator @@ -1450,7 +1450,7 @@ Based on ``value``, enables or disables the specified navigation layer of the Ti void **set_navigation_layer_layers** **(** :ref:`int` layer_index, :ref:`int` layers **)** -Sets the navigation layers (as in the navigation server) for navigation regions is the given TileSet navigation layer. +Sets the navigation layers (as in the navigation server) for navigation regions in the given TileSet navigation layer. .. rst-class:: classref-item-separator @@ -1474,7 +1474,7 @@ Sets the occlusion layer (as in the rendering server) for occluders in the given void **set_occlusion_layer_sdf_collision** **(** :ref:`int` layer_index, :ref:`bool` sdf_collision **)** -Enables or disables sdf collision for occluders in the given TileSet occlusion layer. +Enables or disables SDF collision for occluders in the given TileSet occlusion layer. .. rst-class:: classref-item-separator @@ -1534,7 +1534,7 @@ Changes a source's ID. void **set_source_level_tile_proxy** **(** :ref:`int` source_from, :ref:`int` source_to **)** -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. +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 atlas 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. diff --git a/classes/class_timer.rst b/classes/class_timer.rst index eb6a3c0b061..e6a04015261 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -21,6 +21,8 @@ Description Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one-shot" mode. +\ **Note:** Timers are affected by :ref:`Engine.time_scale`, a higher scale means quicker timeouts, and vice versa. + \ **Note:** To create a one-shot timer without instantiating a node, use :ref:`SceneTree.create_timer`. .. rst-class:: classref-introduction-group @@ -226,7 +228,7 @@ The timer's remaining time in seconds. Returns 0 if the timer is inactive. The wait time in seconds. -\ **Note:** Timers can only emit once per rendered frame at most (or once per physics frame if :ref:`process_callback` is :ref:`TIMER_PROCESS_PHYSICS`). This means very low wait times (lower than 0.05 seconds) will behave in significantly different ways depending on the rendered framerate. For very low wait times, it is recommended to use a process loop in a script instead of using a Timer node. +\ **Note:** Timers can only emit once per rendered frame at most (or once per physics frame if :ref:`process_callback` is :ref:`TIMER_PROCESS_PHYSICS`). This means very low wait times (lower than 0.05 seconds) will behave in significantly different ways depending on the rendered framerate. For very low wait times, it is recommended to use a process loop in a script instead of using a Timer node. Timers are affected by :ref:`Engine.time_scale`, a higher scale means quicker timeouts, and vice versa. .. rst-class:: classref-section-separator diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 7bcf08e599d..0c5a8145f4d 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -85,6 +85,8 @@ Methods +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`basis_xform_inv` **(** :ref:`Vector2` v **)** |const| | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`determinant` **(** **)** |const| | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_origin` **(** **)** |const| | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_rotation` **(** **)** |const| | @@ -326,6 +328,20 @@ This method does not account for translation (the origin vector). ---- +.. _class_Transform2D_method_determinant: + +.. rst-class:: classref-method + +:ref:`float` **determinant** **(** **)** |const| + +Returns the determinant of the basis matrix. If the basis is uniformly scaled, then its determinant equals the square of the scale factor. + +A negative determinant means the basis was flipped, so one part of the scale is negative. A zero determinant means the basis isn't invertible, and is usually considered invalid. + +.. rst-class:: classref-item-separator + +---- + .. _class_Transform2D_method_get_origin: .. rst-class:: classref-method @@ -404,7 +420,7 @@ Returns the inverse of the transform, under the assumption that the transformati :ref:`bool` **is_equal_approx** **(** :ref:`Transform2D` xform **)** |const| -Returns ``true`` if this transform and ``transform`` are approximately equal, by calling ``is_equal_approx`` on each component. +Returns ``true`` if this transform and ``xform`` are approximately equal, by calling ``is_equal_approx`` on each component. .. rst-class:: classref-item-separator @@ -428,7 +444,7 @@ Returns ``true`` if this transform is finite, by calling :ref:`@GlobalScope.is_f :ref:`Transform2D` **looking_at** **(** :ref:`Vector2` target=Vector2(0, 0) **)** |const| -Returns a copy of the transform rotated such that it's rotation on the X-axis points towards the ``target`` position. +Returns a copy of the transform rotated such that the rotated X-axis points towards the ``target`` position. Operations take place in global space. @@ -456,9 +472,7 @@ Returns the transform with the basis orthogonal (90 degrees), and normalized axi Returns a copy of the transform rotated by the given ``angle`` (in radians). -This method is an optimized version of multiplying the given transform ``X``\ - -with a corresponding rotation transform ``R`` from the left, i.e., ``R * X``. +This method is an optimized version of multiplying the given transform ``X`` with a corresponding rotation transform ``R`` from the left, i.e., ``R * X``. This can be seen as transforming with respect to the global/parent frame. @@ -474,9 +488,7 @@ This can be seen as transforming with respect to the global/parent frame. Returns a copy of the transform rotated by the given ``angle`` (in radians). -This method is an optimized version of multiplying the given transform ``X``\ - -with a corresponding rotation transform ``R`` from the right, i.e., ``X * R``. +This method is an optimized version of multiplying the given transform ``X`` with a corresponding rotation transform ``R`` from the right, i.e., ``X * R``. This can be seen as transforming with respect to the local frame. @@ -492,9 +504,7 @@ This can be seen as transforming with respect to the local frame. Returns a copy of the transform scaled by the given ``scale`` factor. -This method is an optimized version of multiplying the given transform ``X``\ - -with a corresponding scaling transform ``S`` from the left, i.e., ``S * X``. +This method is an optimized version of multiplying the given transform ``X`` with a corresponding scaling transform ``S`` from the left, i.e., ``S * X``. This can be seen as transforming with respect to the global/parent frame. @@ -510,9 +520,7 @@ This can be seen as transforming with respect to the global/parent frame. Returns a copy of the transform scaled by the given ``scale`` factor. -This method is an optimized version of multiplying the given transform ``X``\ - -with a corresponding scaling transform ``S`` from the right, i.e., ``X * S``. +This method is an optimized version of multiplying the given transform ``X`` with a corresponding scaling transform ``S`` from the right, i.e., ``X * S``. This can be seen as transforming with respect to the local frame. @@ -528,9 +536,7 @@ This can be seen as transforming with respect to the local frame. Returns a copy of the transform translated by the given ``offset``. -This method is an optimized version of multiplying the given transform ``X``\ - -with a corresponding translation transform ``T`` from the left, i.e., ``T * X``. +This method is an optimized version of multiplying the given transform ``X`` with a corresponding translation transform ``T`` from the left, i.e., ``T * X``. This can be seen as transforming with respect to the global/parent frame. @@ -546,9 +552,7 @@ This can be seen as transforming with respect to the global/parent frame. Returns a copy of the transform translated by the given ``offset``. -This method is an optimized version of multiplying the given transform ``X``\ - -with a corresponding translation transform ``T`` from the right, i.e., ``X * T``. +This method is an optimized version of multiplying the given transform ``X`` with a corresponding translation transform ``T`` from the right, i.e., ``X * T``. This can be seen as transforming with respect to the local frame. diff --git a/classes/class_transform3d.rst b/classes/class_transform3d.rst index b2f377d1be5..b4087924258 100644 --- a/classes/class_transform3d.rst +++ b/classes/class_transform3d.rst @@ -314,7 +314,7 @@ Returns the inverse of the transform, under the assumption that the transformati :ref:`bool` **is_equal_approx** **(** :ref:`Transform3D` xform **)** |const| -Returns ``true`` if this transform and ``transform`` are approximately equal, by calling ``is_equal_approx`` on each component. +Returns ``true`` if this transform and ``xform`` are approximately equal, by calling ``is_equal_approx`` on each component. .. rst-class:: classref-item-separator @@ -368,9 +368,7 @@ Returns a copy of the transform rotated around the given ``axis`` by the given ` The ``axis`` must be a normalized vector. -This method is an optimized version of multiplying the given transform ``X``\ - -with a corresponding rotation transform ``R`` from the left, i.e., ``R * X``. +This method is an optimized version of multiplying the given transform ``X`` with a corresponding rotation transform ``R`` from the left, i.e., ``R * X``. This can be seen as transforming with respect to the global/parent frame. @@ -388,9 +386,7 @@ Returns a copy of the transform rotated around the given ``axis`` by the given ` The ``axis`` must be a normalized vector. -This method is an optimized version of multiplying the given transform ``X``\ - -with a corresponding rotation transform ``R`` from the right, i.e., ``X * R``. +This method is an optimized version of multiplying the given transform ``X`` with a corresponding rotation transform ``R`` from the right, i.e., ``X * R``. This can be seen as transforming with respect to the local frame. @@ -406,9 +402,7 @@ This can be seen as transforming with respect to the local frame. Returns a copy of the transform scaled by the given ``scale`` factor. -This method is an optimized version of multiplying the given transform ``X``\ - -with a corresponding scaling transform ``S`` from the left, i.e., ``S * X``. +This method is an optimized version of multiplying the given transform ``X`` with a corresponding scaling transform ``S`` from the left, i.e., ``S * X``. This can be seen as transforming with respect to the global/parent frame. @@ -424,9 +418,7 @@ This can be seen as transforming with respect to the global/parent frame. Returns a copy of the transform scaled by the given ``scale`` factor. -This method is an optimized version of multiplying the given transform ``X``\ - -with a corresponding scaling transform ``S`` from the right, i.e., ``X * S``. +This method is an optimized version of multiplying the given transform ``X`` with a corresponding scaling transform ``S`` from the right, i.e., ``X * S``. This can be seen as transforming with respect to the local frame. @@ -442,9 +434,7 @@ This can be seen as transforming with respect to the local frame. Returns a copy of the transform translated by the given ``offset``. -This method is an optimized version of multiplying the given transform ``X``\ - -with a corresponding translation transform ``T`` from the left, i.e., ``T * X``. +This method is an optimized version of multiplying the given transform ``X`` with a corresponding translation transform ``T`` from the left, i.e., ``T * X``. This can be seen as transforming with respect to the global/parent frame. @@ -460,9 +450,7 @@ This can be seen as transforming with respect to the global/parent frame. Returns a copy of the transform translated by the given ``offset``. -This method is an optimized version of multiplying the given transform ``X``\ - -with a corresponding translation transform ``T`` from the right, i.e., ``X * T``. +This method is an optimized version of multiplying the given transform ``X`` with a corresponding translation transform ``T`` from the right, i.e., ``X * T``. This can be seen as transforming with respect to the local frame. diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index 6353bac2a72..dda17a771d4 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -379,7 +379,7 @@ Returns the current locale's translation for the given message (key) and context :ref:`StringName` **translate_plural** **(** :ref:`StringName` message, :ref:`StringName` plural_message, :ref:`int` n, :ref:`StringName` context="" **)** |const| -Returns the current locale's translation for the given message (key), plural_message and context. +Returns the current locale's translation for the given message (key), plural message and context. The number ``n`` 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/classes/class_tree.rst b/classes/class_tree.rst index 87fecaee187..411e33ef295 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -69,6 +69,8 @@ Properties +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`allow_rmb_select` | ``false`` | +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`allow_search` | ``true`` | + +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | +------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`column_titles_visible` | ``false`` | @@ -100,77 +102,81 @@ Methods .. table:: :widths: auto - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`create_item` **(** :ref:`TreeItem` parent=null, :ref:`int` index=-1 **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`deselect_all` **(** **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`edit_selected` **(** **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`ensure_cursor_is_visible` **(** **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_button_id_at_position` **(** :ref:`Vector2` position **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_column_at_position` **(** :ref:`Vector2` position **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_column_expand_ratio` **(** :ref:`int` column **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`get_column_title_direction` **(** :ref:`int` column **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_column_title_language` **(** :ref:`int` column **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_column_width` **(** :ref:`int` column **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_custom_popup_rect` **(** **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_drop_section_at_position` **(** :ref:`Vector2` position **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_edited` **(** **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_edited_column` **(** **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`TreeItem` item, :ref:`int` column=-1, :ref:`int` button_index=-1 **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_item_at_position` **(** :ref:`Vector2` position **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`TreeItem` from **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_pressed_button` **(** **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_root` **(** **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_scroll` **(** **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_selected` **(** **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selected_column` **(** **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_column_clipping_content` **(** :ref:`int` column **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_column_expanding` **(** :ref:`int` column **)** |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scroll_to_item` **(** :ref:`TreeItem` item, :ref:`bool` center_on_item=false **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_clip_content` **(** :ref:`int` column, :ref:`bool` enable **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_custom_minimum_width` **(** :ref:`int` column, :ref:`int` min_width **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_expand` **(** :ref:`int` column, :ref:`bool` expand **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_expand_ratio` **(** :ref:`int` column, :ref:`int` ratio **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_title` **(** :ref:`int` column, :ref:`String` title **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_title_direction` **(** :ref:`int` column, :ref:`TextDirection` direction **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_title_language` **(** :ref:`int` column, :ref:`String` language **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_selected` **(** :ref:`TreeItem` item, :ref:`int` column **)** | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`clear` **(** **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`create_item` **(** :ref:`TreeItem` parent=null, :ref:`int` index=-1 **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`deselect_all` **(** **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`edit_selected` **(** **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`ensure_cursor_is_visible` **(** **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_button_id_at_position` **(** :ref:`Vector2` position **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_column_at_position` **(** :ref:`Vector2` position **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_column_expand_ratio` **(** :ref:`int` column **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`HorizontalAlignment` | :ref:`get_column_title_alignment` **(** :ref:`int` column **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`get_column_title_direction` **(** :ref:`int` column **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_column_title_language` **(** :ref:`int` column **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_column_width` **(** :ref:`int` column **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_custom_popup_rect` **(** **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_drop_section_at_position` **(** :ref:`Vector2` position **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_edited` **(** **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_edited_column` **(** **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`TreeItem` item, :ref:`int` column=-1, :ref:`int` button_index=-1 **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_item_at_position` **(** :ref:`Vector2` position **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`TreeItem` from **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_pressed_button` **(** **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_root` **(** **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_scroll` **(** **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_selected` **(** **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selected_column` **(** **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_column_clipping_content` **(** :ref:`int` column **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_column_expanding` **(** :ref:`int` column **)** |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`scroll_to_item` **(** :ref:`TreeItem` item, :ref:`bool` center_on_item=false **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_column_clip_content` **(** :ref:`int` column, :ref:`bool` enable **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_column_custom_minimum_width` **(** :ref:`int` column, :ref:`int` min_width **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_column_expand` **(** :ref:`int` column, :ref:`bool` expand **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_column_expand_ratio` **(** :ref:`int` column, :ref:`int` ratio **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_column_title` **(** :ref:`int` column, :ref:`String` title **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_column_title_alignment` **(** :ref:`int` column, :ref:`HorizontalAlignment` title_alignment **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_column_title_direction` **(** :ref:`int` column, :ref:`TextDirection` direction **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_column_title_language` **(** :ref:`int` column, :ref:`String` language **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_selected` **(** :ref:`TreeItem` item, :ref:`int` column **)** | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -211,6 +217,8 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`h_separation` | ``4`` | +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`icon_max_width` | ``0`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`item_margin` | ``16`` | +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`outline_size` | ``0`` | @@ -225,6 +233,18 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`scroll_speed` | ``12`` | +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`scrollbar_h_separation` | ``4`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`scrollbar_margin_bottom` | ``-1`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`scrollbar_margin_left` | ``-1`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`scrollbar_margin_right` | ``-1`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`scrollbar_margin_top` | ``-1`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`scrollbar_v_separation` | ``4`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`v_separation` | ``4`` | +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Font` | :ref:`font` | | @@ -589,6 +609,23 @@ If ``true``, a right mouse button click can select items. ---- +.. _class_Tree_property_allow_search: + +.. rst-class:: classref-property + +:ref:`bool` **allow_search** = ``true`` + +.. rst-class:: classref-property-setget + +- void **set_allow_search** **(** :ref:`bool` value **)** +- :ref:`bool` **get_allow_search** **(** **)** + +If ``true``, allows navigating the **Tree** with letter keys through incremental search. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_property_column_titles_visible: .. rst-class:: classref-property @@ -865,6 +902,18 @@ Returns the column's title. ---- +.. _class_Tree_method_get_column_title_alignment: + +.. rst-class:: classref-method + +:ref:`HorizontalAlignment` **get_column_title_alignment** **(** :ref:`int` column **)** |const| + +Returns the column title alignment. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_method_get_column_title_direction: .. rst-class:: classref-method @@ -1180,6 +1229,18 @@ Sets the title of a column. ---- +.. _class_Tree_method_set_column_title_alignment: + +.. rst-class:: classref-method + +void **set_column_title_alignment** **(** :ref:`int` column, :ref:`HorizontalAlignment` title_alignment **)** + +Sets the column title alignment. Note that :ref:`@GlobalScope.HORIZONTAL_ALIGNMENT_FILL` is not supported for column titles. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_method_set_column_title_direction: .. rst-class:: classref-method @@ -1401,6 +1462,18 @@ The horizontal space between item cells. This is also used as the margin at the ---- +.. _class_Tree_theme_constant_icon_max_width: + +.. rst-class:: classref-themeproperty + +:ref:`int` **icon_max_width** = ``0`` + +The maximum allowed width of the icon in item's cells. This limit is applied on top of the default size of the icon, but before the value set with :ref:`TreeItem.set_icon_max_width`. The height is adjusted according to the icon's ratio. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_theme_constant_item_margin: .. rst-class:: classref-themeproperty @@ -1487,6 +1560,78 @@ The speed of border scrolling. ---- +.. _class_Tree_theme_constant_scrollbar_h_separation: + +.. rst-class:: classref-themeproperty + +:ref:`int` **scrollbar_h_separation** = ``4`` + +The horizontal separation of tree content and scrollbar. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Tree_theme_constant_scrollbar_margin_bottom: + +.. rst-class:: classref-themeproperty + +:ref:`int` **scrollbar_margin_bottom** = ``-1`` + +The bottom margin of the scrollbars. When negative, uses :ref:`panel` bottom margin. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Tree_theme_constant_scrollbar_margin_left: + +.. rst-class:: classref-themeproperty + +:ref:`int` **scrollbar_margin_left** = ``-1`` + +The left margin of the horizontal scrollbar. When negative, uses :ref:`panel` left margin. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Tree_theme_constant_scrollbar_margin_right: + +.. rst-class:: classref-themeproperty + +:ref:`int` **scrollbar_margin_right** = ``-1`` + +The right margin of the scrollbars. When negative, uses :ref:`panel` right margin. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Tree_theme_constant_scrollbar_margin_top: + +.. rst-class:: classref-themeproperty + +:ref:`int` **scrollbar_margin_top** = ``-1`` + +The right margin of the vertical scrollbar. When negative, uses :ref:`panel` top margin. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Tree_theme_constant_scrollbar_v_separation: + +.. rst-class:: classref-themeproperty + +:ref:`int` **scrollbar_v_separation** = ``4`` + +The vertical separation of tree content and scrollbar. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_theme_constant_v_separation: .. rst-class:: classref-themeproperty diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 70745b6752b..f2d770c3edb 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -146,6 +146,8 @@ Methods +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_custom_set_as_button` **(** :ref:`int` column **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_edit_multiline` **(** :ref:`int` column **)** |const| | + +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_indeterminate` **(** :ref:`int` column **)** |const| | @@ -188,6 +190,8 @@ Methods +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_font_size` **(** :ref:`int` column, :ref:`int` font_size **)** | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_edit_multiline` **(** :ref:`int` column, :ref:`bool` multiline **)** | + +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | @@ -654,7 +658,7 @@ Returns the given column's icon :ref:`Texture2D`. Error if no i :ref:`int` **get_icon_max_width** **(** :ref:`int` column **)** |const| -Returns the column's icon's maximum width. +Returns the maximum allowed width of the icon in the given ``column``. .. rst-class:: classref-item-separator @@ -960,6 +964,18 @@ Returns ``true`` if the given ``column`` is checked. ---- +.. _class_TreeItem_method_is_edit_multiline: + +.. rst-class:: classref-method + +:ref:`bool` **is_edit_multiline** **(** :ref:`int` column **)** |const| + +Returns ``true`` if the given ``column`` is multiline editable. + +.. rst-class:: classref-item-separator + +---- + .. _class_TreeItem_method_is_editable: .. rst-class:: classref-method @@ -1126,7 +1142,7 @@ Sets the given column's cell mode to ``mode``. See :ref:`TreeCellMode` column, :ref:`bool` checked **)** -If ``true``, the given ``column`` is checked. Clears column's indeterminate status. +If ``checked`` is ``true``, the given ``column`` is checked. Clears column's indeterminate status. .. rst-class:: classref-item-separator @@ -1220,13 +1236,27 @@ Sets custom font size used to draw text in the given ``column``. ---- +.. _class_TreeItem_method_set_edit_multiline: + +.. rst-class:: classref-method + +void **set_edit_multiline** **(** :ref:`int` column, :ref:`bool` multiline **)** + +If ``multiline`` is ``true``, the given ``column`` is multiline editable. + +\ **Note:** This option only affects the type of control (:ref:`LineEdit` or :ref:`TextEdit`) that appears when editing the column. You can set multiline values with :ref:`set_text` even if the column is not multiline editable. + +.. rst-class:: classref-item-separator + +---- + .. _class_TreeItem_method_set_editable: .. rst-class:: classref-method void **set_editable** **(** :ref:`int` column, :ref:`bool` enabled **)** -If ``true``, the given ``column`` is editable. +If ``enabled`` is ``true``, the given ``column`` is editable. .. rst-class:: classref-item-separator @@ -1238,7 +1268,7 @@ If ``true``, the given ``column`` is editable. void **set_expand_right** **(** :ref:`int` column, :ref:`bool` enable **)** -If ``true``, the given ``column`` is expanded to the right. +If ``enable`` is ``true``, the given ``column`` is expanded to the right. .. rst-class:: classref-item-separator @@ -1262,7 +1292,7 @@ Sets the given column's icon :ref:`Texture2D`. void **set_icon_max_width** **(** :ref:`int` column, :ref:`int` width **)** -Sets the given column's icon's maximum width. +Sets the maximum allowed width of the icon in the given ``column``. This limit is applied on top of the default size of the icon and on top of :ref:`Tree.icon_max_width`. The height is adjusted according to the icon's ratio. .. rst-class:: classref-item-separator @@ -1298,7 +1328,7 @@ Sets the given column's icon's texture region. void **set_indeterminate** **(** :ref:`int` column, :ref:`bool` indeterminate **)** -If ``true``, the given ``column`` is marked ``indeterminate``. +If ``indeterminate`` is ``true``, the given ``column`` is marked indeterminate. \ **Note:** If set ``true`` from ``false``, then column is cleared of checked status. @@ -1362,7 +1392,7 @@ If ``expr`` is ``true``, the edit mode slider will use an exponential scale as w void **set_selectable** **(** :ref:`int` column, :ref:`bool` selectable **)** -If ``true``, the given column is selectable. +If ``selectable`` is ``true``, the given ``column`` is selectable. .. rst-class:: classref-item-separator diff --git a/classes/class_tubetrailmesh.rst b/classes/class_tubetrailmesh.rst index 89d0d65c151..6a5f056c960 100644 --- a/classes/class_tubetrailmesh.rst +++ b/classes/class_tubetrailmesh.rst @@ -12,9 +12,25 @@ TubeTrailMesh **Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -.. container:: contribute +Represents a straight tube-shaped :ref:`PrimitiveMesh` with variable width. - There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Description +----------- + +**TubeTrailMesh** represents a straight tube-shaped mesh with variable width. The tube is composed of a number of cylindrical sections, each with the same :ref:`section_length` and number of :ref:`section_rings`. A :ref:`curve` is sampled along the total length of the tube, meaning that the curve determines the radius of the tube along its length. + +This primitive mesh is usually used for particle trails. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`3D Particle trails <../tutorials/3d/particles/trails>` + +- :doc:`Particle systems (3D) <../tutorials/3d/particles/index>` .. rst-class:: classref-reftable-group @@ -96,9 +112,7 @@ If ``true``, generates a cap at the top of the tube. This can be set to ``false` - void **set_curve** **(** :ref:`Curve` value **)** - :ref:`Curve` **get_curve** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Determines the radius of the tube along its length. The radius of a particular section ring is obtained by multiplying the baseline :ref:`radius` by the value of this curve at the given distance. For values smaller than ``0``, the faces will be inverted. .. rst-class:: classref-item-separator @@ -115,9 +129,7 @@ If ``true``, generates a cap at the top of the tube. This can be set to ``false` - void **set_radial_steps** **(** :ref:`int` value **)** - :ref:`int` **get_radial_steps** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The number of sides on the tube. For example, a value of ``5`` means the tube will be pentagonal. Higher values result in a more detailed tube at the cost of performance. .. rst-class:: classref-item-separator @@ -134,9 +146,7 @@ If ``true``, generates a cap at the top of the tube. This can be set to ``false` - void **set_radius** **(** :ref:`float` value **)** - :ref:`float` **get_radius** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The baseline radius of the tube. The radius of a particular section ring is obtained by multiplying this radius by the value of the :ref:`curve` at the given distance. .. rst-class:: classref-item-separator @@ -153,9 +163,7 @@ If ``true``, generates a cap at the top of the tube. This can be set to ``false` - void **set_section_length** **(** :ref:`float` value **)** - :ref:`float` **get_section_length** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The length of a section of the tube. .. rst-class:: classref-item-separator @@ -172,9 +180,7 @@ If ``true``, generates a cap at the top of the tube. This can be set to ``false` - void **set_section_rings** **(** :ref:`int` value **)** - :ref:`int` **get_section_rings** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The number of rings in a section. The :ref:`curve` is sampled on each ring to determine its radius. Higher values result in a more detailed tube at the cost of performance. .. rst-class:: classref-item-separator @@ -191,9 +197,7 @@ If ``true``, generates a cap at the top of the tube. This can be set to ``false` - void **set_sections** **(** :ref:`int` value **)** - :ref:`int` **get_sections** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The total number of sections on the tube. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_tween.rst b/classes/class_tween.rst index cc7d2259b0c..00129301fa3 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -141,9 +141,9 @@ Some :ref:`Tweener`\ s use transitions and eases. The first accep \ `Tween easing and transition types cheatsheet `__\ -\ **Note:** All **Tween**\ s will automatically start by default. To prevent a **Tween** from autostarting, you can call :ref:`stop` immediately after it is created. +\ **Note:** Tweens are not designed to be re-used and trying to do so results in an undefined behavior. Create a new Tween for each animation and every time you replay an animation from start. Keep in mind that Tweens start immediately, so only create a Tween when you want to start animating. -\ **Note:** **Tween**\ s are processing after all of nodes in the current frame, i.e. after :ref:`Node._process` or :ref:`Node._physics_process` (depending on :ref:`TweenProcessMode`). +\ **Note:** Tweens are processing after all of nodes in the current frame, i.e. after :ref:`Node._process` or :ref:`Node._physics_process` (depending on :ref:`TweenProcessMode`). .. rst-class:: classref-reftable-group @@ -160,6 +160,8 @@ Methods +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`custom_step` **(** :ref:`float` delta **)** | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_loops_left` **(** **)** |const| | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_total_elapsed_time` **(** **)** |const| | +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`interpolate_value` **(** :ref:`Variant` initial_value, :ref:`Variant` delta_value, :ref:`float` elapsed_time, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type **)** |static| | @@ -218,8 +220,6 @@ Signals Emitted when the **Tween** has finished all tweening. Never emitted when the **Tween** is set to infinite looping (see :ref:`set_loops`). -\ **Note:** The **Tween** is removed (invalidated) in the next processing frame after this signal is emitted. Calling :ref:`stop` inside the signal callback will prevent the **Tween** from being removed. - .. rst-class:: classref-item-separator ---- @@ -513,7 +513,17 @@ Processes the **Tween** by the given ``delta`` value, in seconds. This is mostly Returns ``true`` if the **Tween** still has :ref:`Tweener`\ s that haven't finished. -\ **Note:** The **Tween** will become invalid in the next processing frame after its animation finishes. Calling :ref:`stop` after performing :ref:`custom_step` instead keeps and resets the **Tween**. +.. rst-class:: classref-item-separator + +---- + +.. _class_Tween_method_get_loops_left: + +.. rst-class:: classref-method + +:ref:`int` **get_loops_left** **(** **)** |const| + +Returns the number of remaining loops for this **Tween** (see :ref:`set_loops`). A return value of ``-1`` indicates an infinitely looping **Tween**, and a return value of ``0`` indicates that the **Tween** has already finished. .. rst-class:: classref-item-separator diff --git a/classes/class_udpserver.rst b/classes/class_udpserver.rst index 17eadf9f752..459cf35bbba 100644 --- a/classes/class_udpserver.rst +++ b/classes/class_udpserver.rst @@ -43,7 +43,7 @@ Below a small example of how it can be used: func _process(delta): server.poll() # Important! if server.is_connection_available(): - var peer : PacketPeerUDP = server.take_connection() + var peer: PacketPeerUDP = server.take_connection() var packet = peer.get_packet() print("Accepted peer: %s:%s" % [peer.get_packet_ip(), peer.get_packet_port()]) print("Received data: %s" % [packet.get_string_from_utf8()]) @@ -112,7 +112,7 @@ Below a small example of how it can be used: func _process(delta): if !connected: # Try to contact server - udp.put_packet("The answer is... 42!".to_utf8()) + udp.put_packet("The answer is... 42!".to_utf8_buffer()) if udp.get_available_packet_count() > 0: print("Connected: %s" % udp.get_packet().get_string_from_utf8()) connected = true @@ -137,7 +137,7 @@ Below a small example of how it can be used: if (!_connected) { // Try to contact server - _udp.PutPacket("The Answer Is..42!".ToUtf8()); + _udp.PutPacket("The Answer Is..42!".ToUtf8Buffer()); } if (_udp.GetAvailablePacketCount() > 0) { diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index e9e64bad8ee..36dd14b8e0d 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -12,25 +12,25 @@ UndoRedo **Inherits:** :ref:`Object` -Helper to manage undo/redo operations in the editor or custom tools. +General-purpose helper to manage undo/redo operations. .. rst-class:: classref-introduction-group Description ----------- -Helper to manage undo/redo operations in the editor or custom tools. It works by registering methods and property changes inside "actions". +UndoRedo works by registering methods and property changes inside "actions". Common behavior is to create an action, then add do/undo calls to functions or property changes, then committing the action. -Here's an example on how to add an action to the Godot editor's own **UndoRedo**, from a plugin: +Here's an example on how to add an UndoRedo action: .. tabs:: .. code-tab:: gdscript - var undo_redo = get_undo_redo() # Method of EditorPlugin. + var undo_redo = UndoRedo.new() func do_something(): pass # Put your code here. @@ -41,8 +41,8 @@ Here's an example on how to add an action to the Godot editor's own **UndoRedo** func _on_my_button_pressed(): var node = get_node("MyNode2D") undo_redo.create_action("Move the node") - undo_redo.add_do_method(self, "do_something") - undo_redo.add_undo_method(self, "undo_something") + undo_redo.add_do_method(do_something) + undo_redo.add_undo_method(undo_something) undo_redo.add_do_property(node, "position", Vector2(100,100)) undo_redo.add_undo_property(node, "position", node.position) undo_redo.commit_action() @@ -53,7 +53,7 @@ Here's an example on how to add an action to the Godot editor's own **UndoRedo** public override void _Ready() { - _undoRedo = GetUndoRedo(); // Method of EditorPlugin. + _undoRedo = new UndoRedo(); } public void DoSomething() @@ -83,6 +83,8 @@ Here's an example on how to add an action to the Godot editor's own **UndoRedo** If you don't need to register a method, you can leave :ref:`add_do_method` and :ref:`add_undo_method` out; the same goes for properties. You can also register more than one method/property. +If you are making an :ref:`EditorPlugin` and want to integrate into the editor's undo history, use :ref:`EditorUndoRedoManager` instead. + .. rst-class:: classref-reftable-group Methods @@ -232,6 +234,15 @@ void **add_do_reference** **(** :ref:`Object` object **)** 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. +:: + + var node = Node2D.new() + undo_redo.create_action("Add node") + undo_redo.add_do_method(add_child.bind(node)) + undo_redo.add_do_reference(node) + undo_redo.add_undo_method(remove_child.bind(node)) + undo_redo.commit_action() + .. rst-class:: classref-item-separator ---- @@ -268,6 +279,15 @@ void **add_undo_reference** **(** :ref:`Object` object **)** 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!). +:: + + var node = $Node2D + undo_redo.create_action("Remove node") + undo_redo.add_do_method(remove_child.bind(node)) + undo_redo.add_undo_method(add_child.bind(node)) + undo_redo.add_undo_reference(node) + undo_redo.commit_action() + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index 3ad092e4ea3..16b9a031023 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -463,11 +463,11 @@ Adds the given :ref:`UPNPDevice` to the list of discovered dev :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** |const| -Adds a mapping to forward the external ``port`` (between 1 and 65535, although recommended to use port 1024 or above) on the default gateway (see :ref:`get_gateway`) to the ``internal_port`` on the local machine for the given protocol ``proto`` (either ``"TCP"`` or ``"UDP"``, with UDP being the default). If a port mapping for the given port and protocol combination already exists on that gateway device, this method tries to overwrite it. If that is not desired, you can retrieve the gateway manually with :ref:`get_gateway` and call :ref:`add_port_mapping` on it, if any. Note that forwarding a well-known port (below 1024) with UPnP may fail depending on the device. +Adds a mapping to forward the external ``port`` (between 1 and 65535, although recommended to use port 1024 or above) on the default gateway (see :ref:`get_gateway`) to the ``port_internal`` on the local machine for the given protocol ``proto`` (either ``"TCP"`` or ``"UDP"``, with UDP being the default). If a port mapping for the given port and protocol combination already exists on that gateway device, this method tries to overwrite it. If that is not desired, you can retrieve the gateway manually with :ref:`get_gateway` and call :ref:`add_port_mapping` on it, if any. Note that forwarding a well-known port (below 1024) with UPnP may fail depending on the device. Depending on the gateway device, if a mapping for that port already exists, it will either be updated or it will refuse this command due to that conflict, especially if the existing mapping for that port wasn't created via UPnP or points to a different network address (or device) than this one. -If ``internal_port`` is ``0`` (the default), the same port number is used for both the external and the internal port (the ``port`` value). +If ``port_internal`` is ``0`` (the default), the same port number is used for both the external and the internal port (the ``port`` value). The description (``desc``) is shown in some routers management UIs and can be used to point out which application added the mapping. diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index f9318884da8..b501d9c4b35 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -534,7 +534,7 @@ This is the signed area of the parallelogram formed by the two vectors. If the s :ref:`Vector2` **cubic_interpolate** **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` weight **)** |const| -Cubically interpolates between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. +Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. .. rst-class:: classref-item-separator @@ -546,7 +546,7 @@ Cubically interpolates between this vector and ``b`` using ``pre_a`` and ``post_ :ref:`Vector2` **cubic_interpolate_in_time** **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` weight, :ref:`float` b_t, :ref:`float` pre_a_t, :ref:`float` post_b_t **)** |const| -Cubically interpolates between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. +Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. It can perform smoother interpolation than ``cubic_interpolate()`` by the time values. @@ -646,7 +646,7 @@ Creates a unit **Vector2** rotated to the given ``angle`` in radians. This is eq :ref:`bool` **is_equal_approx** **(** :ref:`Vector2` to **)** |const| -Returns ``true`` if this vector and ``v`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. +Returns ``true`` if this vector and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. .. rst-class:: classref-item-separator @@ -670,7 +670,7 @@ Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_fini :ref:`bool` **is_normalized** **(** **)** |const| -Returns ``true`` if the vector is normalized, ``false`` otherwise. +Returns ``true`` if the vector is normalized, i.e. its length is approximately equal to 1. .. rst-class:: classref-item-separator @@ -722,7 +722,7 @@ This method runs faster than :ref:`length`, so pref :ref:`Vector2` **lerp** **(** :ref:`Vector2` to, :ref:`float` weight **)** |const| -Returns the result of the linear interpolation between this vector and ``to`` by amount ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. +Returns the result of the linear interpolation between this vector and ``to`` by amount ``weight``. ``weight`` is on the range of ``0.0`` to ``1.0``, representing the amount of interpolation. .. rst-class:: classref-item-separator @@ -782,7 +782,9 @@ Returns a new vector moved toward ``to`` by the fixed ``delta`` amount. Will not :ref:`Vector2` **normalized** **(** **)** |const| -Returns a new vector scaled to unit length. Equivalent to ``v / v.length()``. +Returns the result of scaling the vector to unit length. Equivalent to ``v / v.length()``. See also :ref:`is_normalized`. + +\ **Note:** This function may return incorrect values if the input vector length is near zero. .. rst-class:: classref-item-separator diff --git a/classes/class_vector2i.rst b/classes/class_vector2i.rst index 0d0fcf28b7c..8808d0408a6 100644 --- a/classes/class_vector2i.rst +++ b/classes/class_vector2i.rst @@ -279,7 +279,7 @@ Constructs a **Vector2i** as a copy of the given **Vector2i**. :ref:`Vector2i` **Vector2i** **(** :ref:`Vector2` from **)** -Constructs a new **Vector2i** from :ref:`Vector2`. The floating point coordinates will be truncated. +Constructs a new **Vector2i** from the given :ref:`Vector2` by truncating components' fractional parts (rounding towards zero). For a different behavior consider passing the result of :ref:`Vector2.ceil`, :ref:`Vector2.floor` or :ref:`Vector2.round` to this constructor instead. .. rst-class:: classref-item-separator @@ -449,7 +449,7 @@ Gets the remainder of each component of the **Vector2i** with the components of :ref:`Vector2i` **operator %** **(** :ref:`int` right **)** -Gets the remainder of each component of the **Vector2i** with the the given :ref:`int`. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. +Gets the remainder of each component of the **Vector2i** with the given :ref:`int`. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. :: diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 597dc8eeff7..6ff2f4fbac1 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -654,7 +654,7 @@ Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_fini :ref:`bool` **is_normalized** **(** **)** |const| -Returns ``true`` if the vector is :ref:`normalized`, ``false`` otherwise. +Returns ``true`` if the vector is normalized, i.e. its length is approximately equal to 1. .. rst-class:: classref-item-separator @@ -706,7 +706,7 @@ This method runs faster than :ref:`length`, so pref :ref:`Vector3` **lerp** **(** :ref:`Vector3` to, :ref:`float` weight **)** |const| -Returns the result of the linear interpolation between this vector and ``to`` by amount ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. +Returns the result of the linear interpolation between this vector and ``to`` by amount ``weight``. ``weight`` is on the range of ``0.0`` to ``1.0``, representing the amount of interpolation. .. rst-class:: classref-item-separator @@ -766,7 +766,9 @@ Returns a new vector moved toward ``to`` by the fixed ``delta`` amount. Will not :ref:`Vector3` **normalized** **(** **)** |const| -Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. See also :ref:`is_normalized`. +Returns the result of scaling the vector to unit length. Equivalent to ``v / v.length()``. See also :ref:`is_normalized`. + +\ **Note:** This function may return incorrect values if the input vector length is near zero. .. rst-class:: classref-item-separator diff --git a/classes/class_vector3i.rst b/classes/class_vector3i.rst index 15bb14d6552..8b346677ba1 100644 --- a/classes/class_vector3i.rst +++ b/classes/class_vector3i.rst @@ -315,7 +315,7 @@ Constructs a **Vector3i** as a copy of the given **Vector3i**. :ref:`Vector3i` **Vector3i** **(** :ref:`Vector3` from **)** -Constructs a new **Vector3i** from :ref:`Vector3`. The floating point coordinates will be truncated. +Constructs a new **Vector3i** from the given :ref:`Vector3` by truncating components' fractional parts (rounding towards zero). For a different behavior consider passing the result of :ref:`Vector3.ceil`, :ref:`Vector3.floor` or :ref:`Vector3.round` to this constructor instead. .. rst-class:: classref-item-separator @@ -473,7 +473,7 @@ Gets the remainder of each component of the **Vector3i** with the components of :ref:`Vector3i` **operator %** **(** :ref:`int` right **)** -Gets the remainder of each component of the **Vector3i** with the the given :ref:`int`. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. +Gets the remainder of each component of the **Vector3i** with the given :ref:`int`. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. :: diff --git a/classes/class_vector4.rst b/classes/class_vector4.rst index fe4bae2e1ed..e3d2ba106c0 100644 --- a/classes/class_vector4.rst +++ b/classes/class_vector4.rst @@ -92,7 +92,7 @@ Methods +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`inverse` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Vector4` with **)** |const| | + | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Vector4` to **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -483,9 +483,9 @@ Returns the inverse of the vector. This is the same as ``Vector4(1.0 / v.x, 1.0 .. rst-class:: classref-method -:ref:`bool` **is_equal_approx** **(** :ref:`Vector4` with **)** |const| +:ref:`bool` **is_equal_approx** **(** :ref:`Vector4` to **)** |const| -Returns ``true`` if this vector and ``with`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. +Returns ``true`` if this vector and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. .. rst-class:: classref-item-separator @@ -509,7 +509,7 @@ Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_fini :ref:`bool` **is_normalized** **(** **)** |const| -Returns ``true`` if the vector is normalized, i.e. its length is equal to 1. +Returns ``true`` if the vector is normalized, i.e. its length is approximately equal to 1. .. rst-class:: classref-item-separator @@ -547,7 +547,9 @@ Returns the length (magnitude) of this vector. :ref:`float` **length_squared** **(** **)** |const| -Returns the squared length (squared magnitude) of this vector. This method runs faster than :ref:`length`. +Returns the squared length (squared magnitude) of this vector. + +This method runs faster than :ref:`length`, so prefer it if you need to compare vectors or need the squared distance for some formula. .. rst-class:: classref-item-separator @@ -595,7 +597,9 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all :ref:`Vector4` **normalized** **(** **)** |const| -Returns the result of scaling the vector to unit length. Equivalent to ``v / v.length()``. +Returns the result of scaling the vector to unit length. Equivalent to ``v / v.length()``. See also :ref:`is_normalized`. + +\ **Note:** This function may return incorrect values if the input vector length is near zero. .. rst-class:: classref-item-separator @@ -607,7 +611,7 @@ Returns the result of scaling the vector to unit length. Equivalent to ``v / v.l :ref:`Vector4` **posmod** **(** :ref:`float` mod **)** |const| -Returns a new vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``mod``. +Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``mod``. .. rst-class:: classref-item-separator @@ -619,7 +623,7 @@ Returns a new vector composed of the :ref:`@GlobalScope.fposmod` **posmodv** **(** :ref:`Vector4` modv **)** |const| -Returns a new vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``modv``'s components. +Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``modv``'s components. .. rst-class:: classref-item-separator diff --git a/classes/class_vector4i.rst b/classes/class_vector4i.rst index e21d5f01c0f..0ee3718498c 100644 --- a/classes/class_vector4i.rst +++ b/classes/class_vector4i.rst @@ -276,7 +276,7 @@ Constructs a **Vector4i** as a copy of the given **Vector4i**. :ref:`Vector4i` **Vector4i** **(** :ref:`Vector4` from **)** -Constructs a new **Vector4i** from the given :ref:`Vector4`. +Constructs a new **Vector4i** from the given :ref:`Vector4` by truncating components' fractional parts (rounding towards zero). For a different behavior consider passing the result of :ref:`Vector4.ceil`, :ref:`Vector4.floor` or :ref:`Vector4.round` to this constructor instead. .. rst-class:: classref-item-separator @@ -339,7 +339,9 @@ Returns the length (magnitude) of this vector. :ref:`int` **length_squared** **(** **)** |const| -Returns the squared length (squared magnitude) of this vector. This method runs faster than :ref:`length`. +Returns the squared length (squared magnitude) of this vector. + +This method runs faster than :ref:`length`, so prefer it if you need to compare vectors or need the squared distance for some formula. .. rst-class:: classref-item-separator diff --git a/classes/class_vehiclewheel3d.rst b/classes/class_vehiclewheel3d.rst index 01ffe2053dd..149963048b0 100644 --- a/classes/class_vehiclewheel3d.rst +++ b/classes/class_vehiclewheel3d.rst @@ -53,7 +53,7 @@ Properties +---------------------------+---------------------------------------------------------------------------------+------------+ | :ref:`float` | :ref:`suspension_stiffness` | ``5.88`` | +---------------------------+---------------------------------------------------------------------------------+------------+ - | :ref:`float` | :ref:`suspension_travel` | ``5.0`` | + | :ref:`float` | :ref:`suspension_travel` | ``0.2`` | +---------------------------+---------------------------------------------------------------------------------+------------+ | :ref:`bool` | :ref:`use_as_steering` | ``false`` | +---------------------------+---------------------------------------------------------------------------------+------------+ @@ -222,7 +222,7 @@ This value defines the stiffness of the suspension. Use a value lower than 50 fo .. rst-class:: classref-property -:ref:`float` **suspension_travel** = ``5.0`` +:ref:`float` **suspension_travel** = ``0.2`` .. rst-class:: classref-property-setget diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index f25fc29e902..461a5c727d9 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -334,7 +334,7 @@ enum **Scaling3DMode**: :ref:`Scaling3DMode` **SCALING_3D_MODE_BILINEAR** = ``0`` -Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`scaling_3d_scale`. Values less then ``1.0`` will result in undersampling while values greater than ``1.0`` will result in supersampling. A value of ``1.0`` disables scaling. +Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`scaling_3d_scale`. Values less than ``1.0`` will result in undersampling while values greater than ``1.0`` will result in supersampling. A value of ``1.0`` disables scaling. .. _class_Viewport_constant_SCALING_3D_MODE_FSR: @@ -342,7 +342,7 @@ Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be :ref:`Scaling3DMode` **SCALING_3D_MODE_FSR** = ``1`` -Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`scaling_3d_scale`. Values less then ``1.0`` will be result in the viewport being upscaled using FSR. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. +Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. .. _class_Viewport_constant_SCALING_3D_MODE_MAX: @@ -1199,7 +1199,7 @@ If ``true``, the GUI controls on the viewport will lay pixel perfectly. - void **set_handle_input_locally** **(** :ref:`bool` value **)** - :ref:`bool` **is_handling_input_locally** **(** **)** -If ``true``, this viewport will mark incoming input events as handled by itself. If ``false``, this is instead done by the the first parent viewport that is set to handle input locally. +If ``true``, this viewport will mark incoming input events as handled by itself. If ``false``, this is instead done by the first parent viewport that is set to handle input locally. A :ref:`SubViewportContainer` will automatically set this property to ``false`` for the **Viewport** contained inside of it. @@ -1860,9 +1860,7 @@ Returns the :ref:`PositionalShadowAtlasQuadrantSubdiv` **get_render_info** **(** :ref:`RenderInfoType` type, :ref:`RenderInfo` info **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns rendering statistics of the given type. See :ref:`RenderInfoType` and :ref:`RenderInfo` for options. .. rst-class:: classref-item-separator @@ -2032,9 +2030,7 @@ If an earlier method marks the input as handled via :ref:`set_input_as_handled` text **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Helper method which calls the ``set_text()`` method on the currently focused :ref:`Control`, provided that it is defined (e.g. if the focused Control is :ref:`Button` or :ref:`LineEdit`). .. rst-class:: classref-item-separator diff --git a/classes/class_visualinstance3d.rst b/classes/class_visualinstance3d.rst index ee90f213e24..ef104aa9312 100644 --- a/classes/class_visualinstance3d.rst +++ b/classes/class_visualinstance3d.rst @@ -85,7 +85,7 @@ Property Descriptions The render layer(s) this **VisualInstance3D** is drawn on. -This object will only be visible for :ref:`Camera3D`\ s whose cull mask includes the render object this **VisualInstance3D** is set to. +This object will only be visible for :ref:`Camera3D`\ s whose cull mask includes any of the render layers this **VisualInstance3D** is set to. For :ref:`Light3D`\ s, this can be used to control which **VisualInstance3D**\ s are affected by a specific light. For :ref:`GPUParticles3D`, this can be used to control which particles are effected by a specific attractor. For :ref:`Decal`\ s, this can be used to control which **VisualInstance3D**\ s are affected by a specific decal. diff --git a/classes/class_visualshadernodetextureparameter.rst b/classes/class_visualshadernodetextureparameter.rst index f146ef8fd4d..eef8bbedb52 100644 --- a/classes/class_visualshadernodetextureparameter.rst +++ b/classes/class_visualshadernodetextureparameter.rst @@ -381,7 +381,7 @@ Sets the texture repeating mode. See :ref:`TextureRepeat` value **)** - :ref:`TextureSource` **get_texture_source** **(** **)** -Sets the texture source mode. Used for reading from the screen, depth, or normal_roughness texture. see :ref:`TextureSource` for options. +Sets the texture source mode. Used for reading from the screen, depth, or normal_roughness texture. See :ref:`TextureSource` for options. .. rst-class:: classref-item-separator diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index bfa079f579a..ed682e60acf 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -45,6 +45,8 @@ Theme Properties .. table:: :widths: auto + +-----------------------------------+---------------------------------------------------------------------------------+-------+ + | :ref:`int` | :ref:`center_grabber` | ``0`` | +-----------------------------------+---------------------------------------------------------------------------------+-------+ | :ref:`int` | :ref:`grabber_offset` | ``0`` | +-----------------------------------+---------------------------------------------------------------------------------+-------+ @@ -72,6 +74,18 @@ Theme Properties Theme Property Descriptions --------------------------- +.. _class_VSlider_theme_constant_center_grabber: + +.. rst-class:: classref-themeproperty + +:ref:`int` **center_grabber** = ``0`` + +Boolean constant. If ``1``, the grabber texture size will be ignored and it will fit within slider's bounds based only on its center position. + +.. rst-class:: classref-item-separator + +---- + .. _class_VSlider_theme_constant_grabber_offset: .. rst-class:: classref-themeproperty diff --git a/classes/class_webrtcmultiplayerpeer.rst b/classes/class_webrtcmultiplayerpeer.rst index eee4f3e7ab2..1df42307215 100644 --- a/classes/class_webrtcmultiplayerpeer.rst +++ b/classes/class_webrtcmultiplayerpeer.rst @@ -70,7 +70,7 @@ Method Descriptions Add a new peer to the mesh with the given ``peer_id``. The :ref:`WebRTCPeerConnection` must be in state :ref:`WebRTCPeerConnection.STATE_NEW`. -Three channels will be created for reliable, unreliable, and ordered transport. The value of ``unreliable_lifetime`` will be passed to the ``maxPacketLifetime`` option when creating unreliable and ordered channels (see :ref:`WebRTCPeerConnection.create_data_channel`). +Three channels will be created for reliable, unreliable, and ordered transport. The value of ``unreliable_lifetime`` will be passed to the ``"maxPacketLifetime"`` option when creating unreliable and ordered channels (see :ref:`WebRTCPeerConnection.create_data_channel`). .. rst-class:: classref-item-separator @@ -122,7 +122,7 @@ You can optionally specify a ``channels_config`` array of :ref:`TransferMode` **get_peer** **(** :ref:`int` peer_id **)** -Returns a dictionary representation of the peer with given ``peer_id`` with three keys. ``connection`` containing the :ref:`WebRTCPeerConnection` to this peer, ``channels`` an array of three :ref:`WebRTCDataChannel`, and ``connected`` a boolean representing if the peer connection is currently connected (all three channels are open). +Returns a dictionary representation of the peer with given ``peer_id`` with three keys. ``"connection"`` containing the :ref:`WebRTCPeerConnection` to this peer, ``"channels"`` an array of three :ref:`WebRTCDataChannel`, and ``"connected"`` a boolean representing if the peer connection is currently connected (all three channels are open). .. rst-class:: classref-item-separator diff --git a/classes/class_webrtcpeerconnection.rst b/classes/class_webrtcpeerconnection.rst index d315dc349c9..bc75fef6101 100644 --- a/classes/class_webrtcpeerconnection.rst +++ b/classes/class_webrtcpeerconnection.rst @@ -308,7 +308,7 @@ Close the peer connection and all data channels associated with it. Returns a new :ref:`WebRTCDataChannel` (or ``null`` on failure) with given ``label`` and optionally configured via the ``options`` dictionary. This method can only be called when the connection is in state :ref:`STATE_NEW`. -There are two ways to create a working data channel: either call :ref:`create_data_channel` on only one of the peer and listen to :ref:`data_channel_received` on the other, or call :ref:`create_data_channel` on both peers, with the same values, and the ``negotiated`` option set to ``true``. +There are two ways to create a working data channel: either call :ref:`create_data_channel` on only one of the peer and listen to :ref:`data_channel_received` on the other, or call :ref:`create_data_channel` on both peers, with the same values, and the ``"negotiated"`` option set to ``true``. Valid ``options`` are: @@ -388,9 +388,9 @@ Returns the :ref:`SignalingState` on t :ref:`Error` **initialize** **(** :ref:`Dictionary` configuration={} **)** -Re-initialize this peer connection, closing any previously active connection, and going back to state :ref:`STATE_NEW`. A dictionary of ``options`` can be passed to configure the peer connection. +Re-initialize this peer connection, closing any previously active connection, and going back to state :ref:`STATE_NEW`. A dictionary of ``configuration`` options can be passed to configure the peer connection. -Valid ``options`` are: +Valid ``configuration`` options are: :: @@ -457,9 +457,9 @@ After calling this function the peer will start emitting :ref:`ice_candidate_cre Sets the SDP description of the remote peer. This should be called with the values generated by a remote peer and received over the signaling server. -If ``type`` is ``offer`` the peer will emit :ref:`session_description_created` with the appropriate answer. +If ``type`` is ``"offer"`` the peer will emit :ref:`session_description_created` with the appropriate answer. -If ``type`` is ``answer`` the peer will start emitting :ref:`ice_candidate_created`. +If ``type`` is ``"answer"`` the peer will start emitting :ref:`ice_candidate_created`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_websocketmultiplayerpeer.rst b/classes/class_websocketmultiplayerpeer.rst index a406303890e..e02089dc637 100644 --- a/classes/class_websocketmultiplayerpeer.rst +++ b/classes/class_websocketmultiplayerpeer.rst @@ -201,7 +201,7 @@ Starts a new multiplayer client connecting to the given ``url``. TLS certificate :ref:`Error` **create_server** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`TLSOptions` tls_server_options=null **)** -Starts a new multiplayer server listening on the given ``port``. You can optionally specify a ``bind_address``, and provide valiid ``tls_server_options`` to use TLS. See :ref:`TLSOptions.server`. +Starts a new multiplayer server listening on the given ``port``. You can optionally specify a ``bind_address``, and provide valid ``tls_server_options`` to use TLS. See :ref:`TLSOptions.server`. .. rst-class:: classref-item-separator diff --git a/classes/class_webxrinterface.rst b/classes/class_webxrinterface.rst index 0aef1bbb046..70607330578 100644 --- a/classes/class_webxrinterface.rst +++ b/classes/class_webxrinterface.rst @@ -150,6 +150,10 @@ Methods .. table:: :widths: auto + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_available_display_refresh_rates` **(** **)** |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_display_refresh_rate` **(** **)** |const| | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TargetRayMode` | :ref:`get_input_source_target_ray_mode` **(** :ref:`int` input_source_id **)** |const| | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -159,6 +163,8 @@ Methods +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`is_session_supported` **(** :ref:`String` session_mode **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_display_refresh_rate` **(** :ref:`float` refresh_rate **)** | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -169,6 +175,18 @@ Methods Signals ------- +.. _class_WebXRInterface_signal_display_refresh_rate_changed: + +.. rst-class:: classref-signal + +**display_refresh_rate_changed** **(** **)** + +Emitted after the display's refresh rate has changed. + +.. rst-class:: classref-item-separator + +---- + .. _class_WebXRInterface_signal_reference_space_reset: .. rst-class:: classref-signal @@ -518,6 +536,30 @@ Possible values come from `WebXR's XRVisibilityState ` **get_available_display_refresh_rates** **(** **)** |const| + +Returns display refresh rates supported by the current HMD. Only returned if this feature is supported by the web browser and after the interface has been initialized. + +.. rst-class:: classref-item-separator + +---- + +.. _class_WebXRInterface_method_get_display_refresh_rate: + +.. rst-class:: classref-method + +:ref:`float` **get_display_refresh_rate** **(** **)** |const| + +Returns the display refresh rate for the current HMD. Not supported on all HMDs and browsers. It may not report an accurate value until after using :ref:`set_display_refresh_rate`. + +.. rst-class:: classref-item-separator + +---- + .. _class_WebXRInterface_method_get_input_source_target_ray_mode: .. rst-class:: classref-method @@ -584,6 +626,18 @@ Possible values come from `WebXR's XRSessionMode ` signal with the result. +.. rst-class:: classref-item-separator + +---- + +.. _class_WebXRInterface_method_set_display_refresh_rate: + +.. rst-class:: classref-method + +void **set_display_refresh_rate** **(** :ref:`float` refresh_rate **)** + +Sets the display refresh rate for the current HMD. Not supported on all HMDs and browsers. It won't take effect right away until after :ref:`display_refresh_rate_changed` is emitted. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_window.rst b/classes/class_window.rst index a4ce2bfe04b..53d820aabb4 100644 --- a/classes/class_window.rst +++ b/classes/class_window.rst @@ -557,7 +557,7 @@ The window can't be focused. No-focus window will ignore all input, except mouse :ref:`Flags` **FLAG_POPUP** = ``5`` -Window is part of menu or :ref:`OptionButton` dropdown. This flag can't be changed when the window is visible. An active popup window will exclusively receive all input, without stealing focus from its parent. Popup windows are automatically closed when uses click outside it, or when an application is switched. Popup window must have ``transient parent`` set (see :ref:`transient`). +Window is part of menu or :ref:`OptionButton` dropdown. This flag can't be changed when the window is visible. An active popup window will exclusively receive all input, without stealing focus from its parent. Popup windows are automatically closed when uses click outside it, or when an application is switched. Popup window must have transient parent set (see :ref:`transient`). .. _class_Window_constant_FLAG_EXTEND_TO_TITLE: @@ -667,7 +667,7 @@ The content can be expanded horizontally. Scaling vertically will result in keep :ref:`ContentScaleAspect` **CONTENT_SCALE_ASPECT_EXPAND** = ``4`` -The content's aspect will be preserved. If the target size has different aspect from the base one, the content will stay in the to-left corner and add an extra visible area in the stretched space. +The content's aspect will be preserved. If the target size has different aspect from the base one, the content will stay in the top-left corner and add an extra visible area in the stretched space. .. rst-class:: classref-item-separator @@ -735,7 +735,7 @@ Initial window position is determined by :ref:`position` **WINDOW_INITIAL_POSITION_CENTER_PRIMARY_SCREEN** = ``1`` -Initial window position is a center of the primary screen. +Initial window position is the center of the primary screen. .. _class_Window_constant_WINDOW_INITIAL_POSITION_CENTER_MAIN_WINDOW_SCREEN: @@ -743,7 +743,7 @@ Initial window position is a center of the primary screen. :ref:`WindowInitialPosition` **WINDOW_INITIAL_POSITION_CENTER_MAIN_WINDOW_SCREEN** = ``2`` -Initial window position is a center of the main window screen. +Initial window position is the center of the main window screen. .. _class_Window_constant_WINDOW_INITIAL_POSITION_CENTER_OTHER_SCREEN: @@ -751,7 +751,23 @@ Initial window position is a center of the main window screen. :ref:`WindowInitialPosition` **WINDOW_INITIAL_POSITION_CENTER_OTHER_SCREEN** = ``3`` -Initial window position is a center of :ref:`current_screen` screen. +Initial window position is the center of :ref:`current_screen` screen. + +.. _class_Window_constant_WINDOW_INITIAL_POSITION_CENTER_SCREEN_WITH_MOUSE_FOCUS: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowInitialPosition` **WINDOW_INITIAL_POSITION_CENTER_SCREEN_WITH_MOUSE_FOCUS** = ``4`` + +Initial window position is the center of the screen containing the mouse pointer. + +.. _class_Window_constant_WINDOW_INITIAL_POSITION_CENTER_SCREEN_WITH_KEYBOARD_FOCUS: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowInitialPosition` **WINDOW_INITIAL_POSITION_CENTER_SCREEN_WITH_KEYBOARD_FOCUS** = ``5`` + +Initial window position is the center of the screen containing the window with the keyboard focus. .. rst-class:: classref-section-separator @@ -1054,7 +1070,7 @@ Set's the window's current mode. - void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enabled **)** - :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| -If ``true``, all mouse event as passed to the underlying window of the same application. See also :ref:`mouse_passthrough_polygon`. +If ``true``, all mouse events will be passed to the underlying window of the same application. See also :ref:`mouse_passthrough_polygon`. \ **Note:** This property is implemented on Linux (X11), macOS and Windows. @@ -1144,6 +1160,8 @@ If ``true``, the **Window** will be considered a popup. Popups are sub-windows t The window's position in pixels. +If :ref:`ProjectSettings.display/window/subwindows/embed_subwindows` is ``false``, the position is in absolute screen coordinates. This typically applies to editor plugins. If the setting is ``false``, the window's position is in the coordinates of its parent :ref:`Viewport`. + .. rst-class:: classref-item-separator ---- @@ -1229,7 +1247,7 @@ The window's title. If the **Window** is non-embedded, title styles set in :ref: - void **set_transient** **(** :ref:`bool` value **)** - :ref:`bool` **is_transient** **(** **)** -If ``true``, the **Window** is transient, i.e. it's considered a child of another **Window**. Transient window is will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode. +If ``true``, the **Window** is transient, i.e. it's considered a child of another **Window**. The transient window will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode. Note that behavior might be different depending on the platform. @@ -1921,9 +1939,7 @@ Moves the **Window** on top of other windows and focuses it. void **popup** **(** :ref:`Rect2i` rect=Rect2i(0, 0, 0, 0) **)** -Shows the **Window** and makes it transient (see :ref:`transient`). If ``rect`` is provided, it will be set as the **Window**'s size. - -Fails if called on the main window. +Shows the **Window** and makes it transient (see :ref:`transient`). If ``rect`` is provided, it will be set as the **Window**'s size. Fails if called on the main window. .. rst-class:: classref-item-separator @@ -1935,9 +1951,7 @@ Fails if called on the main window. void **popup_centered** **(** :ref:`Vector2i` minsize=Vector2i(0, 0) **)** -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 :ref:`Viewport` instead. +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 :ref:`Viewport` instead. \ **Note:** Calling it with the default value of ``minsize`` is equivalent to calling it with :ref:`size`. @@ -1951,9 +1965,7 @@ If the **Window** is embedded, it will be centered in the parent :ref:`Viewport< void **popup_centered_clamped** **(** :ref:`Vector2i` minsize=Vector2i(0, 0), :ref:`float` fallback_ratio=0.75 **)** -Popups the **Window** centered inside its parent **Window**. - -\ ``fallback_ratio`` determines the maximum size of the **Window**, in relation to its parent. +Popups the **Window** centered inside its parent **Window**. ``fallback_ratio`` determines the maximum size of the **Window**, in relation to its parent. \ **Note:** Calling it with the default value of ``minsize`` is equivalent to calling it with :ref:`size`. @@ -1979,9 +1991,7 @@ Popups the **Window** centered inside its parent **Window** and sets its size as void **popup_on_parent** **(** :ref:`Rect2i` parent_rect **)** -Popups the **Window** with a position shifted by parent **Window**'s position. - -If the **Window** is embedded, has the same effect as :ref:`popup`. +Popups the **Window** with a position shifted by parent **Window**'s position. If the **Window** is embedded, has the same effect as :ref:`popup`. .. rst-class:: classref-item-separator diff --git a/classes/class_xrinterface.rst b/classes/class_xrinterface.rst index 51e0ba98a83..585c73f5560 100644 --- a/classes/class_xrinterface.rst +++ b/classes/class_xrinterface.rst @@ -71,6 +71,8 @@ Methods +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_supported_environment_blend_modes` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_system_info` **(** **)** | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TrackingStatus` | :ref:`get_tracking_status` **(** **)** |const| | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`get_transform_for_view` **(** :ref:`int` view, :ref:`Transform3D` cam_transform **)** | @@ -286,7 +288,7 @@ Player is free to move around, full positional tracking. :ref:`PlayAreaMode` **XR_PLAY_AREA_STAGE** = ``4`` -Same as roomscale but origin point is fixed to the center of the physical space, XRServer.center_on_hmd disabled. +Same as :ref:`XR_PLAY_AREA_ROOMSCALE` but origin point is fixed to the center of the physical space, :ref:`XRServer.center_on_hmd` disabled. .. rst-class:: classref-item-separator @@ -471,6 +473,20 @@ Returns the an array of supported environment blend modes, see :ref:`Environment ---- +.. _class_XRInterface_method_get_system_info: + +.. rst-class:: classref-method + +:ref:`Dictionary` **get_system_info** **(** **)** + +Returns a :ref:`Dictionary` with extra system info. Interfaces are expected to return ``XRRuntimeName`` and ``XRRuntimeVersion`` providing info about the used XR runtime. Additional entries may be provided specific to an interface. + +\ **Note:**\ This information may only be available after :ref:`initialize` was successfully called. + +.. rst-class:: classref-item-separator + +---- + .. _class_XRInterface_method_get_tracking_status: .. rst-class:: classref-method @@ -493,7 +509,7 @@ Returns the transform for a view/eye. \ ``view`` is the view/eye index. -\ ``cam_transform`` is the transform that maps device coordinates to scene coordinates, typically the global_transform of the current XROrigin3D. +\ ``cam_transform`` is the transform that maps device coordinates to scene coordinates, typically the :ref:`Node3D.global_transform` of the current XROrigin3D. .. rst-class:: classref-item-separator @@ -582,9 +598,9 @@ Sets the active environment blend mode. :: func _ready(): - var xr_interface : XRInterface = XRServer.find_interface("OpenXR") + var xr_interface: XRInterface = XRServer.find_interface("OpenXR") if xr_interface and xr_interface.is_initialized(): - var vp : Viewport = get_viewport() + var vp: Viewport = get_viewport() vp.use_xr = true var acceptable_modes = [ XRInterface.XR_ENV_BLEND_MODE_OPAQUE, XRInterface.XR_ENV_BLEND_MODE_ADDITIVE ] var modes = xr_interface.get_supported_environment_blend_modes() diff --git a/classes/class_xrinterfaceextension.rst b/classes/class_xrinterfaceextension.rst index d2e120554e2..4561b5aa30f 100644 --- a/classes/class_xrinterfaceextension.rst +++ b/classes/class_xrinterfaceextension.rst @@ -58,6 +58,8 @@ Methods +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_suggested_tracker_names` **(** **)** |virtual| |const| | +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_system_info` **(** **)** |virtual| |const| | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TrackingStatus` | :ref:`_get_tracking_status` **(** **)** |virtual| |const| | +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`_get_transform_for_view` **(** :ref:`int` view, :ref:`Transform3D` cam_transform **)** |virtual| | @@ -278,6 +280,18 @@ Returns a :ref:`PackedStringArray` with tracker names c ---- +.. _class_XRInterfaceExtension_method__get_system_info: + +.. rst-class:: classref-method + +:ref:`Dictionary` **_get_system_info** **(** **)** |virtual| |const| + +Returns a :ref:`Dictionary` with system informationr elated to this interface. + +.. rst-class:: classref-item-separator + +---- + .. _class_XRInterfaceExtension_method__get_tracking_status: .. rst-class:: classref-method @@ -394,7 +408,7 @@ Called if this is our primary **XRInterfaceExtension** before we start processin void **_pre_render** **(** **)** |virtual| -Called if this **XRInterfaceExtension** is active before rendering starts, most XR interfaces will sync tracking at this point in time. +Called if this **XRInterfaceExtension** is active before rendering starts. Most XR interfaces will sync tracking at this point in time. .. rst-class:: classref-item-separator @@ -406,7 +420,7 @@ Called if this **XRInterfaceExtension** is active before rendering starts, most void **_process** **(** **)** |virtual| -Called if this **XRInterfaceExtension** is active before our physics and game process is called. most XR interfaces will update its :ref:`XRPositionalTracker`\ s at this point in time. +Called if this **XRInterfaceExtension** is active before our physics and game process is called. Most XR interfaces will update its :ref:`XRPositionalTracker`\ s at this point in time. .. rst-class:: classref-item-separator diff --git a/classes/class_xrserver.rst b/classes/class_xrserver.rst index b0fabe6d579..ce89a78e0fb 100644 --- a/classes/class_xrserver.rst +++ b/classes/class_xrserver.rst @@ -36,11 +36,13 @@ Properties .. table:: :widths: auto - +---------------------------------------+---------------------------------------------------------------------+---------+ - | :ref:`XRInterface` | :ref:`primary_interface` | | - +---------------------------------------+---------------------------------------------------------------------+---------+ - | :ref:`float` | :ref:`world_scale` | ``1.0`` | - +---------------------------------------+---------------------------------------------------------------------+---------+ + +---------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`XRInterface` | :ref:`primary_interface` | | + +---------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Transform3D` | :ref:`world_origin` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | + +---------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`float` | :ref:`world_scale` | ``1.0`` | + +---------------------------------------+---------------------------------------------------------------------+-----------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -274,6 +276,25 @@ The primary :ref:`XRInterface` currently bound to the **XRSer ---- +.. _class_XRServer_property_world_origin: + +.. rst-class:: classref-property + +:ref:`Transform3D` **world_origin** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` + +.. rst-class:: classref-property-setget + +- void **set_world_origin** **(** :ref:`Transform3D` value **)** +- :ref:`Transform3D` **get_world_origin** **(** **)** + +The current origin of our tracking space in the virtual world. This is used by the renderer to properly position the camera with new tracking data. + +\ **Note:** This property is managed by the current :ref:`XROrigin3D` node. It is exposed for access from GDExtensions. + +.. rst-class:: classref-item-separator + +---- + .. _class_XRServer_property_world_scale: .. rst-class:: classref-property diff --git a/classes/index.rst b/classes/index.rst index f59f1761fd0..e85d80c295f 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -92,7 +92,6 @@ Nodes class_editorfiledialog class_editorfilesystem class_editorinspector - class_editorinterface class_editorplugin class_editorproperty class_editorresourcepicker @@ -386,12 +385,14 @@ Resources class_gltfanimation class_gltfbufferview class_gltfcamera + class_gltfcollider class_gltfdocument class_gltfdocumentextension class_gltfdocumentextensionconvertimportermesh class_gltflight class_gltfmesh class_gltfnode + class_gltfphysicsbody class_gltfskeleton class_gltfskin class_gltfspecgloss @@ -438,6 +439,7 @@ Resources class_navigationpolygon class_noise class_noisetexture2d + class_noisetexture3d class_occluder3d class_occluderpolygon2d class_oggpacketsequence @@ -656,7 +658,6 @@ Other objects class_object class_aescontext - class_animationtrackeditplugin class_astar2d class_astar3d class_astargrid2d @@ -681,12 +682,20 @@ Other objects class_editordebuggerplugin class_editordebuggersession class_editorexportplatform + class_editorexportplatformandroid + class_editorexportplatformios + class_editorexportplatformlinuxbsd + class_editorexportplatformmacos + class_editorexportplatformpc + class_editorexportplatformweb + class_editorexportplatformwindows class_editorexportplugin class_editorfeatureprofile class_editorfilesystemdirectory class_editorfilesystemimportformatsupportquery class_editorimportplugin class_editorinspectorplugin + class_editorinterface class_editornode3dgizmo class_editorpaths class_editorresourceconversionplugin @@ -736,6 +745,7 @@ Other objects class_lightmapperrd class_mainloop class_marshalls + class_meshconvexdecompositionsettings class_meshdatatool class_methodtweener class_mobilevrinterface @@ -877,6 +887,63 @@ Other objects class_zippacker class_zipreader +Editor-only +=========== + +.. toctree:: + :maxdepth: 1 + :name: toc-class-ref-editors + + class_editorcommandpalette + class_editordebuggerplugin + class_editordebuggersession + class_editorexportplatform + class_editorexportplatformandroid + class_editorexportplatformios + class_editorexportplatformlinuxbsd + class_editorexportplatformmacos + class_editorexportplatformpc + class_editorexportplatformweb + class_editorexportplatformwindows + class_editorexportplugin + class_editorfeatureprofile + class_editorfiledialog + class_editorfilesystem + class_editorfilesystemdirectory + class_editorfilesystemimportformatsupportquery + class_editorimportplugin + class_editorinspector + class_editorinspectorplugin + class_editorinterface + class_editornode3dgizmo + class_editornode3dgizmoplugin + class_editorpaths + class_editorplugin + class_editorproperty + class_editorresourceconversionplugin + class_editorresourcepicker + class_editorresourcepreview + class_editorresourcepreviewgenerator + class_editorsceneformatimporter + class_editorsceneformatimporterblend + class_editorsceneformatimporterfbx + class_editorsceneformatimportergltf + class_editorscenepostimport + class_editorscenepostimportplugin + class_editorscript + class_editorscriptpicker + class_editorselection + class_editorsettings + class_editorspinslider + class_editorsyntaxhighlighter + class_editortranslationparserplugin + class_editorundoredomanager + class_editorvcsinterface + class_filesystemdock + class_scriptcreatedialog + class_scripteditor + class_scripteditorbase + Variant types ============= @@ -884,6 +951,7 @@ Variant types :maxdepth: 1 :name: toc-class-ref-variants + class_variant class_aabb class_array class_basis @@ -915,7 +983,6 @@ Variant types class_stringname class_transform2d class_transform3d - class_variant class_vector2 class_vector2i class_vector3