diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index fe2dd2b9e..78f8e933f 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -1559,3 +1559,27 @@ From the caller, call :ref:`GDScriptFunctionState.resume` resource's rotation expressed as a :ref:`Basis` +:ref:`Sky` resource's rotation expressed as a :ref:`Basis`. ---- @@ -708,7 +708,7 @@ Defines the mode of background. | *Getter* | get_sky_rotation() | +-----------+-------------------------+ -:ref:`Sky` resource's rotation expressed as euler angles in radians +:ref:`Sky` resource's rotation expressed as Euler angles in radians. ---- @@ -724,7 +724,7 @@ Defines the mode of background. | *Getter* | get_sky_rotation_degrees() | +-----------+---------------------------------+ -:ref:`Sky` resource's rotation expressed as euler angles in degrees +:ref:`Sky` resource's rotation expressed as Euler angles in degrees. ---- diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 3f181b55b..463d00660 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -40,8 +40,6 @@ Properties +---------------------------------------+------------------------------------------------------------------+--------------------+ | :ref:`MeshLibrary` | :ref:`mesh_library` | | +---------------------------------------+------------------------------------------------------------------+--------------------+ -| :ref:`MeshLibrary` | :ref:`theme` | | -+---------------------------------------+------------------------------------------------------------------+--------------------+ Methods ------- @@ -251,20 +249,6 @@ The dimensions of the grid's cells. The assigned :ref:`MeshLibrary`. ----- - -.. _class_GridMap_property_theme: - -- :ref:`MeshLibrary` **theme** - -+----------+------------------+ -| *Setter* | set_theme(value) | -+----------+------------------+ -| *Getter* | get_theme() | -+----------+------------------+ - -Deprecated, use :ref:`mesh_library` instead. - Method Descriptions ------------------- diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 55a8c01f5..b6129d819 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -26,6 +26,8 @@ Properties +-------------------------------------+-------------------------------------------------------------------------------+-------+ | :ref:`StreamPeer` | :ref:`connection` | | +-------------------------------------+-------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`read_chunk_size` | 4096 | ++-------------------------------------+-------------------------------------------------------------------------------+-------+ Methods ------- @@ -59,8 +61,6 @@ Methods +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`request_raw` **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_read_chunk_size` **(** :ref:`int` bytes **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -454,6 +454,22 @@ If ``true``, execution will block until all data is read from the response. The connection to use for this client. +---- + +.. _class_HTTPClient_property_read_chunk_size: + +- :ref:`int` **read_chunk_size** + ++-----------+----------------------------+ +| *Default* | 4096 | ++-----------+----------------------------+ +| *Setter* | set_read_chunk_size(value) | ++-----------+----------------------------+ +| *Getter* | get_read_chunk_size() | ++-----------+----------------------------+ + +The size of the buffer used and maximum bytes to read per iteration. See :ref:`read_response_body_chunk`. + Method Descriptions ------------------- @@ -613,11 +629,3 @@ Headers are HTTP request headers. For available HTTP methods, see ``METHOD_*``. Sends the body data raw, as a byte array and does not encode it in any way. ----- - -.. _class_HTTPClient_method_set_read_chunk_size: - -- void **set_read_chunk_size** **(** :ref:`int` bytes **)** - -Sets the size of the buffer used and maximum bytes to read per iteration. See :ref:`read_response_body_chunk`. - diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index c2833b1b6..96c5c5b0e 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -21,17 +21,19 @@ A node with the ability to send HTTP(S) requests. Properties ---------- -+-----------------------------+--------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`body_size_limit` | -1 | -+-----------------------------+--------------------------------------------------------------------+-------+ -| :ref:`String` | :ref:`download_file` | "" | -+-----------------------------+--------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`max_redirects` | 8 | -+-----------------------------+--------------------------------------------------------------------+-------+ -| :ref:`int` | :ref:`timeout` | 0 | -+-----------------------------+--------------------------------------------------------------------+-------+ -| :ref:`bool` | :ref:`use_threads` | false | -+-----------------------------+--------------------------------------------------------------------+-------+ ++-----------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`body_size_limit` | -1 | ++-----------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`download_chunk_size` | 4096 | ++-----------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`download_file` | "" | ++-----------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`max_redirects` | 8 | ++-----------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`timeout` | 0 | ++-----------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`use_threads` | false | ++-----------------------------+----------------------------------------------------------------------------+-------+ Methods ------- @@ -180,6 +182,24 @@ Maximum allowed size for response bodies. ---- +.. _class_HTTPRequest_property_download_chunk_size: + +- :ref:`int` **download_chunk_size** + ++-----------+--------------------------------+ +| *Default* | 4096 | ++-----------+--------------------------------+ +| *Setter* | set_download_chunk_size(value) | ++-----------+--------------------------------+ +| *Getter* | get_download_chunk_size() | ++-----------+--------------------------------+ + +The size of the buffer used and maximum bytes to read per iteration. See :ref:`HTTPClient.read_chunk_size`. + +Set this to a higher value (e.g. 65536 for 64 KiB) when downloading large files to achieve better speeds at the cost of memory. + +---- + .. _class_HTTPRequest_property_download_file: - :ref:`String` **download_file** diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index 21986f333..904ff5fca 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -30,6 +30,8 @@ Properties +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ | :ref:`bool` | refuse_new_connections | **O:** false | +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`server_relay` | true | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ | :ref:`int` | :ref:`transfer_channel` | -1 | +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ | :ref:`TransferMode` | transfer_mode | **O:** 2 | @@ -148,6 +150,22 @@ The compression method used for network packets. These have different tradeoffs ---- +.. _class_NetworkedMultiplayerENet_property_server_relay: + +- :ref:`bool` **server_relay** + ++-----------+---------------------------------+ +| *Default* | true | ++-----------+---------------------------------+ +| *Setter* | set_server_relay_enabled(value) | ++-----------+---------------------------------+ +| *Getter* | is_server_relay_enabled() | ++-----------+---------------------------------+ + +Enable or disable the server feature that notifies clients of other peers' connection/disconnection, and relays messages between them. When this option is ``false``, clients won't be automatically notified of other peers and won't be able to send them packets through the server. + +---- + .. _class_NetworkedMultiplayerENet_property_transfer_channel: - :ref:`int` **transfer_channel** diff --git a/classes/class_node.rst b/classes/class_node.rst index 13c4c12a6..464334e9b 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -823,7 +823,7 @@ Returns the peer ID of the network master for this node. See :ref:`set_network_m - :ref:`Node` **get_node** **(** :ref:`NodePath` path **)** const -Fetches a node. The :ref:`NodePath` can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a ``null instance`` is returned and attempts to access it will result in an "Attempt to call on a null instance." error. +Fetches a node. The :ref:`NodePath` can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a ``null instance`` is returned and an error is logged. Attempts to access methods on the return value will result in an "Attempt to call on a null instance." error. **Note:** Fetching absolute paths only works when the node is inside the scene tree (see :ref:`is_inside_tree`). @@ -873,7 +873,7 @@ For example, assuming that ``Area2D/CollisionShape2D`` is a valid node and that - :ref:`Node` **get_node_or_null** **(** :ref:`NodePath` path **)** const -Similar to :ref:`get_node`, but does not raise an error if ``path`` does not point to a valid ``Node``. +Similar to :ref:`get_node`, but does not log an error if ``path`` does not point to a valid ``Node``. ---- diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 4444f474d..fe09fc86d 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -77,7 +77,7 @@ Constants Description ----------- -Popup is a base :ref:`Control` used to show dialogs and popups. It's a subwindow and modal by default (see :ref:`Control`) and has helpers for custom popup behavior. +Popup is a base :ref:`Control` used to show dialogs and popups. It's a subwindow and modal by default (see :ref:`Control`) and has helpers for custom popup behavior. All popup methods ensure correct placement within the viewport. Property Descriptions --------------------- diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index fa66ce214..4b38feadb 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -949,6 +949,8 @@ Returns ``true`` if there are visible modals on-screen. - :ref:`bool` **gui_is_dragging** **(** **)** const +Returns ``true`` if the viewport is currently performing a drag operation. + ---- .. _class_Viewport_method_input: diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index 0f74b0db6..64856f5e0 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -63,3 +63,9 @@ If ``true``, the viewport will be scaled to the control's size. | *Getter* | get_stretch_shrink() | +-----------+---------------------------+ +Divides the viewport's effective resolution by this value while preserving its scale. This can be used to speed up rendering. + +For example, a 1280×720 viewport with :ref:`stretch_shrink` set to ``2`` will be rendered at 640×360 while occupying the same size in the container. + +**Note:** :ref:`stretch` must be ``true`` for this property to work. +