A node with the ability to send HTTP(S) requests.
A node with the ability to send HTTP requests. Uses [HTTPClient] internally.
Can be used to make HTTP requests, i.e. download or upload files or web content via HTTP.
[b]Example of loading and displaying an image using HTTPRequest:[/b]
[codeblock]
func _ready():
# Create an HTTP request node and connect its completion signal.
var http_request = HTTPRequest.new()
add_child(http_request)
http_request.connect("request_completed", self, "_http_request_completed")
# Perform the HTTP request. The URL below returns a PNG image as of writing.
var error = http_request.request("https://via.placeholder.com/512")
if error != OK:
push_error("An error occurred in the HTTP request.")
# Called when the HTTP request is completed.
func _http_request_completed(result, response_code, headers, body):
var image = Image.new()
var error = image.load_png_from_buffer(body)
if error != OK:
push_error("Couldn't load the image.")
var texture = ImageTexture.new()
texture.create_from_image(image)
# Display the image in a TextureRect node.
var texture_rect = TextureRect.new()
add_child(texture_rect)
texture_rect.texture = texture
[/codeblock]
https://docs.godotengine.org/en/latest/tutorials/networking/http_request_class.html
https://docs.godotengine.org/en/latest/tutorials/networking/ssl_certificates.html
Cancels the current request.
Returns the response body length.
[b]Note:[/b] Some Web servers may not send a body length. In this case, the value returned will be [code]-1[/code]. If using chunked transfer encoding, the body length will also be [code]-1[/code].
Returns the amount of bytes this HTTPRequest downloaded.
Returns the current status of the underlying [HTTPClient]. See [enum HTTPClient.Status].
Creates request on the underlying [HTTPClient]. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request].
Returns [constant OK] if request is successfully created. (Does not imply that the server has responded), [constant ERR_UNCONFIGURED] if not in the tree, [constant ERR_BUSY] if still processing previous request, [constant ERR_INVALID_PARAMETER] if given string is not a valid URL format, or [constant ERR_CANT_CONNECT] if not using thread and the [HTTPClient] cannot connect to host.
Maximum allowed size for response bodies.
The size of the buffer used and maximum bytes to read per iteration. See [member 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.
The file to download into. Will output any received file into it.
Maximum number of allowed redirects.
If [code]true[/code], multithreading is used to improve performance.
Emitted when a request is completed.
Request successful.
Request failed while connecting.
Request failed while resolving.
Request failed due to connection (read/write) error.
Request failed on SSL handshake.
Request does not have a response (yet).
Request exceeded its maximum size limit, see [member body_size_limit].
Request failed. (Unused)
HTTPRequest couldn't open the download file.
HTTPRequest couldn't write to the download file.
Request reached its maximum redirect limit, see [member max_redirects].