godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (705b7a0)

Browse Source
This commit is contained in:
Godot Organization
2024-05-31 13:54:35 +00:00
parent 32f1b6ea48
commit eacfba2716
835 changed files with 17350 additions and 17256 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
classes/class_httprequest.rst
View File

@@ -257,7 +257,7 @@ Signals
.. rst-class:: classref-signal
**request_completed**\ (\ result\: :ref:`int<class_int>`, response_code\: :ref:`int<class_int>`, headers\: :ref:`PackedStringArray<class_PackedStringArray>`, body\: :ref:`PackedByteArray<class_PackedByteArray>`\ )
**request_completed**\ (\ result\: :ref:`int<class_int>`, response_code\: :ref:`int<class_int>`, headers\: :ref:`PackedStringArray<class_PackedStringArray>`, body\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_HTTPRequest_signal_request_completed>`
Emitted when a request is completed.
@@ -274,7 +274,7 @@ Enumerations
.. rst-class:: classref-enumeration
enum **Result**:
enum **Result**: :ref:`🔗<enum_HTTPRequest_Result>`
.. _class_HTTPRequest_constant_RESULT_SUCCESS:
@@ -409,7 +409,7 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`bool<class_bool>` **accept_gzip** = ``true``
:ref:`bool<class_bool>` **accept_gzip** = ``true`` :ref:`🔗<class_HTTPRequest_property_accept_gzip>`
.. rst-class:: classref-property-setget
@@ -432,7 +432,7 @@ If ``false`` no header will be added, and no decompression will be performed on
.. rst-class:: classref-property
:ref:`int<class_int>` **body_size_limit** = ``-1``
:ref:`int<class_int>` **body_size_limit** = ``-1`` :ref:`🔗<class_HTTPRequest_property_body_size_limit>`
.. rst-class:: classref-property-setget
@@ -449,7 +449,7 @@ Maximum allowed size for response bodies. If the response body is compressed, th
.. rst-class:: classref-property
:ref:`int<class_int>` **download_chunk_size** = ``65536``
:ref:`int<class_int>` **download_chunk_size** = ``65536`` :ref:`🔗<class_HTTPRequest_property_download_chunk_size>`
.. rst-class:: classref-property-setget
@@ -468,7 +468,7 @@ Set this to a lower value (e.g. 4096 for 4 KiB) when downloading small files to
.. rst-class:: classref-property
:ref:`String<class_String>` **download_file** = ``""``
:ref:`String<class_String>` **download_file** = ``""`` :ref:`🔗<class_HTTPRequest_property_download_file>`
.. rst-class:: classref-property-setget
@@ -485,7 +485,7 @@ The file to download into. Will output any received file into it.
.. rst-class:: classref-property
:ref:`int<class_int>` **max_redirects** = ``8``
:ref:`int<class_int>` **max_redirects** = ``8`` :ref:`🔗<class_HTTPRequest_property_max_redirects>`
.. rst-class:: classref-property-setget
@@ -502,7 +502,7 @@ Maximum number of allowed redirects.
.. rst-class:: classref-property
:ref:`float<class_float>` **timeout** = ``0.0``
:ref:`float<class_float>` **timeout** = ``0.0`` :ref:`🔗<class_HTTPRequest_property_timeout>`
.. rst-class:: classref-property-setget
@@ -519,7 +519,7 @@ The duration to wait in seconds before a request times out. If :ref:`timeout<cla
.. rst-class:: classref-property
:ref:`bool<class_bool>` **use_threads** = ``false``
:ref:`bool<class_bool>` **use_threads** = ``false`` :ref:`🔗<class_HTTPRequest_property_use_threads>`
.. rst-class:: classref-property-setget
@@ -541,7 +541,7 @@ Method Descriptions
.. rst-class:: classref-method
|void| **cancel_request**\ (\ )
|void| **cancel_request**\ (\ ) :ref:`🔗<class_HTTPRequest_method_cancel_request>`
Cancels the current request.
@@ -553,7 +553,7 @@ Cancels the current request.
.. rst-class:: classref-method
:ref:`int<class_int>` **get_body_size**\ (\ ) |const|
:ref:`int<class_int>` **get_body_size**\ (\ ) |const| :ref:`🔗<class_HTTPRequest_method_get_body_size>`
Returns the response body length.
@@ -567,7 +567,7 @@ Returns the response body length.
.. rst-class:: classref-method
:ref:`int<class_int>` **get_downloaded_bytes**\ (\ ) |const|
:ref:`int<class_int>` **get_downloaded_bytes**\ (\ ) |const| :ref:`🔗<class_HTTPRequest_method_get_downloaded_bytes>`
Returns the number of bytes this HTTPRequest downloaded.
@@ -579,7 +579,7 @@ Returns the number of bytes this HTTPRequest downloaded.
.. rst-class:: classref-method
:ref:`Status<enum_HTTPClient_Status>` **get_http_client_status**\ (\ ) |const|
:ref:`Status<enum_HTTPClient_Status>` **get_http_client_status**\ (\ ) |const| :ref:`🔗<class_HTTPRequest_method_get_http_client_status>`
Returns the current status of the underlying :ref:`HTTPClient<class_HTTPClient>`. See :ref:`Status<enum_HTTPClient_Status>`.
@@ -591,7 +591,7 @@ Returns the current status of the underlying :ref:`HTTPClient<class_HTTPClient>`
.. rst-class:: classref-method
:ref:`Error<enum_@GlobalScope_Error>` **request**\ (\ url\: :ref:`String<class_String>`, custom_headers\: :ref:`PackedStringArray<class_PackedStringArray>` = PackedStringArray(), method\: :ref:`Method<enum_HTTPClient_Method>` = 0, request_data\: :ref:`String<class_String>` = ""\ )
:ref:`Error<enum_@GlobalScope_Error>` **request**\ (\ url\: :ref:`String<class_String>`, custom_headers\: :ref:`PackedStringArray<class_PackedStringArray>` = PackedStringArray(), method\: :ref:`Method<enum_HTTPClient_Method>` = 0, request_data\: :ref:`String<class_String>` = ""\ ) :ref:`🔗<class_HTTPRequest_method_request>`
Creates request on the underlying :ref:`HTTPClient<class_HTTPClient>`. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host<class_HTTPClient_method_connect_to_host>` and passes parameters onto :ref:`HTTPClient.request<class_HTTPClient_method_request>`.
@@ -609,7 +609,7 @@ Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if request is suc
.. rst-class:: classref-method
:ref:`Error<enum_@GlobalScope_Error>` **request_raw**\ (\ url\: :ref:`String<class_String>`, custom_headers\: :ref:`PackedStringArray<class_PackedStringArray>` = PackedStringArray(), method\: :ref:`Method<enum_HTTPClient_Method>` = 0, request_data_raw\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray()\ )
:ref:`Error<enum_@GlobalScope_Error>` **request_raw**\ (\ url\: :ref:`String<class_String>`, custom_headers\: :ref:`PackedStringArray<class_PackedStringArray>` = PackedStringArray(), method\: :ref:`Method<enum_HTTPClient_Method>` = 0, request_data_raw\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray()\ ) :ref:`🔗<class_HTTPRequest_method_request_raw>`
Creates request on the underlying :ref:`HTTPClient<class_HTTPClient>` using a raw array of bytes for the request body. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host<class_HTTPClient_method_connect_to_host>` and passes parameters onto :ref:`HTTPClient.request<class_HTTPClient_method_request>`.
@@ -623,7 +623,7 @@ Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if request is suc
.. rst-class:: classref-method
|void| **set_http_proxy**\ (\ host\: :ref:`String<class_String>`, port\: :ref:`int<class_int>`\ )
|void| **set_http_proxy**\ (\ host\: :ref:`String<class_String>`, port\: :ref:`int<class_int>`\ ) :ref:`🔗<class_HTTPRequest_method_set_http_proxy>`
Sets the proxy server for HTTP requests.
@@ -637,7 +637,7 @@ The proxy server is unset if ``host`` is empty or ``port`` is -1.
.. rst-class:: classref-method
|void| **set_https_proxy**\ (\ host\: :ref:`String<class_String>`, port\: :ref:`int<class_int>`\ )
|void| **set_https_proxy**\ (\ host\: :ref:`String<class_String>`, port\: :ref:`int<class_int>`\ ) :ref:`🔗<class_HTTPRequest_method_set_https_proxy>`
Sets the proxy server for HTTPS requests.
@@ -651,7 +651,7 @@ The proxy server is unset if ``host`` is empty or ``port`` is -1.
.. rst-class:: classref-method
|void| **set_tls_options**\ (\ client_options\: :ref:`TLSOptions<class_TLSOptions>`\ )
|void| **set_tls_options**\ (\ client_options\: :ref:`TLSOptions<class_TLSOptions>`\ ) :ref:`🔗<class_HTTPRequest_method_set_tls_options>`
Sets the :ref:`TLSOptions<class_TLSOptions>` to be used when connecting to an HTTPS server. See :ref:`TLSOptions.client<class_TLSOptions_method_client>`.