WebView

The fundamental Control node to present a webview.

Properties

Property	Type	Description
full_window_size	bool	Webview will always be the same size as the viewport.
url	String	Initial URL to be loaded. This will override html.
html	String	HTML string to be loaded. This will be ignored if url is provided.
transparent	bool	Webview should be transparent.
autoplay	bool	Media can be played without user interaction.
background_color	Color	🚧 Not implemented. Webview background color. This will be ignored if transparent is set to true.
devtools	bool	Enables web inspector. To open it, you can call open_devtools(), or right click the page and open it.
headers	Dictionary	🚧 Not implemented. Headers used when loading the requested URL.
user_agent	String	Custom user agent header.
zoom_hotkeys	bool	Enables page zooming hotkeys.
clipboard	bool	Enables clipboard access on Linux and Windows. Always enabled on macOS.
incognito	bool	Run the webview with incognito mode.
focused_when_created	bool	Webview will be focused when created.
forward_input_events	bool	Mouse and keyboard events captured by the webview will be propagated to the game.

Methods

TIP

This node gives you GDScript access to WRY's WebView features plus some extra methods. It doesn't match WRY's API exactly. If anything is missing, contributions are welcome!

clear_all_browsing_data()

Clears all browsing data (such as cookies, cache, and local storage).

WRY Documentation

API

func clear_all_browsing_data() -> void:

Returns: void

eval(...)

Evaluate and run JavaScript code.

WRY Documentation

Example

$WebView.eval("console.log(Math.PI)")

This will print 3.141592653589793 to the DevTools.

Retrieving result

You can call JavaScript code (including asynchronous) and listen to the ipc_message signal to retrieve the result:

func _on_button_pressed() -> void:
	$WebView.eval("
		const resp = await fetch('https://httpbin.org/ip');
		const data = await resp.json();
		ipc.postMessage(JSON.stringify({
			type: "my-ip",
			data
		}));
	")

func _on_web_view_ipc_message(message: String) -> void:
	var data = JSON.parse_string(message)
	if data.type == "my-ip":
		print("Your IP address is: %s" % data.origin)

We include an extra type field in the message payload to explicitly identify the kind of message being sent. This allows us to distinguish between different messages and handle them accordingly.

API

func eval(js: String) -> void:

Parameter	Type	Description
js	String	JavaScript code to be evaluated.

Returns: void

focus()

Tries moving focus to the webview, making it the active element that will receive keyboard and mouse input events.

WRY Documentation

API

func focus() -> void:

Returns: void

focus_parent()

Tries moving focus away from the webview back to the parent window.

WRY Documentation

API

func focus_parent() -> void:

Returns: void

is_devtools_open()

Returns if the developer tools window is currently open.

WRY Documentation

API

func is_devtools_open() -> bool:

Returns: bool

load_html(...)

Load HTML content into the webview.

WRY Documentation

API

func load_html(html: String) -> void:

Parameter	Type	Description
html	String	The HTML content to load.

Returns: void

load_url(...)

Navigate to the specified URL.

WRY Documentation

API

func load_url(url: String) -> void:

Parameter	Type	Description
url	String	The URL to load in the webview.

Returns: void

open_devtools()

Open the webview's web inspector (usually called DevTools). Only works if the devtools property is enabled.

WRY Documentation

API

func open_devtools() -> void:

Returns: void

close_devtools()

Closes the webview's web inspector (usually called DevTools) if it's open.

WRY Documentation

API

func close_devtools() -> void:

Returns: void

post_message(...)

Sends a message to the web content. The message will be received as a message event in JavaScript.

TIP

Using JSON strings are convenient for structured data and handling multiple messages.

Example

Sending a simple message:

$WebView.post_message("Hello from Godot!")

Sending JSON:

var data = {
  "action": "update_health",
  "health": 42
}
$WebView.post_message(JSON.stringify(data))

API

func post_message(message: String) -> void:

Parameter	Type	Description
message	String	The message to be sent to JavaScript.

Returns: void

print()

Opens a dialog to print the current webview content.

WRY Documentation

API

func print() -> void:

Returns: void

reload()

Reloads the current page in the webview.

WRY Documentation

API

func reload() -> void:

Returns: void

resize()

Manually resizes the webview based on the current control size or viewport size.

If full_window_size is set to true, it will be resized to the full viewport size. Otherwise, it will use the control's position and size.

NOTE

Usually you don't need to call this method directly, as the webview automatically resizes when the control or viewport changes size.

API

func resize() -> void:

Returns: void

set_visible(...)

Shows or hides the webview.

WRY Documentation

API

func set_visible(visible: bool) -> void:

Parameter	Type	Description
visible	bool	Whether the webview should be visible.

Returns: void

update_visibility()

Updates the webview's visibility based on whether the control is visible in the scene tree.

NOTE

This is automatically called when the control's visibility changes. You generally don't need to call this method directly. If you want to change the visibility, use set_visible() instead.

API

func update_visibility() -> void:

Returns: void

zoom(...)

Changes the zoom level of the page.

WRY Documentation

Example

# Set zoom to 150%
$WebView.zoom(1.5)

# Reset to default zoom
$WebView.zoom(1.0)

API

func zoom(factor: float) -> void:

Parameter	Type	Description
factor	float	The zoom factor (1.0 is default).

Returns: void

Signals

ipc_message(...)

Emitted when JavaScript code in the WebView sends a message using ipc.postMessage(). This allows communication between JavaScript and your Godot game.

Example

func _ready() -> void:
	$WebView.connect("ipc_message", self, "_on_ipc_message")
	$WebView.load_html('
		<button onclick="sendMessage()">Send message</button>
		<script>
			function sendMessage() {
				ipc.postMessage(JSON.stringify({
					type: "button_clicked",
					timestamp: new Date.now()
				}));
			}
		</script>
	')

func _on_ipc_message(message: String) -> void:
	var data = JSON.parse_string(message)
	if data.type == "button_clicked":
		print("Button was clicked at: %s" % data.timestamp)

API

signal ipc_message(message: String)

Parameter	Type	Description
message	String	The message sent from the WebView's JavaScript.