86 lines
5.1 KiB
XML
86 lines
5.1 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="JavaScriptBridge" inherits="Object" version="4.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Singleton that connects the engine with the browser's JavaScript context in Web export.
|
|
</brief_description>
|
|
<description>
|
|
The JavaScriptBridge singleton is implemented only in the Web export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs.
|
|
[b]Note:[/b] This singleton can be disabled at build-time to improve security. By default, the JavaScriptBridge singleton is enabled. Official export templates also have the JavaScriptBridge singleton enabled. See [url=$DOCS_URL/contributing/development/compiling/compiling_for_web.html]Compiling for the Web[/url] in the documentation for more information.
|
|
</description>
|
|
<tutorials>
|
|
<link title="Exporting for the Web: Calling JavaScript from script">$DOCS_URL/tutorials/export/exporting_for_web.html#calling-javascript-from-script</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="create_callback">
|
|
<return type="JavaScriptObject" />
|
|
<param index="0" name="callable" type="Callable" />
|
|
<description>
|
|
Creates a reference to a [Callable] that can be used as a callback by JavaScript. The reference must be kept until the callback happens, or it won't be called at all. See [JavaScriptObject] for usage.
|
|
</description>
|
|
</method>
|
|
<method name="create_object" qualifiers="vararg">
|
|
<return type="Variant" />
|
|
<param index="0" name="object" type="String" />
|
|
<description>
|
|
Creates a new JavaScript object using the [code]new[/code] constructor. The [param object] must a valid property of the JavaScript [code]window[/code]. See [JavaScriptObject] for usage.
|
|
</description>
|
|
</method>
|
|
<method name="download_buffer">
|
|
<return type="void" />
|
|
<param index="0" name="buffer" type="PackedByteArray" />
|
|
<param index="1" name="name" type="String" />
|
|
<param index="2" name="mime" type="String" default=""application/octet-stream"" />
|
|
<description>
|
|
Prompts the user to download a file containing the specified [param buffer]. The file will have the given [param name] and [param mime] type.
|
|
[b]Note:[/b] The browser may override the [url=https://en.wikipedia.org/wiki/Media_type]MIME type[/url] provided based on the file [param name]'s extension.
|
|
[b]Note:[/b] Browsers might block the download if [method download_buffer] is not being called from a user interaction (e.g. button click).
|
|
[b]Note:[/b] Browsers might ask the user for permission or block the download if multiple download requests are made in a quick succession.
|
|
</description>
|
|
</method>
|
|
<method name="eval">
|
|
<return type="Variant" />
|
|
<param index="0" name="code" type="String" />
|
|
<param index="1" name="use_global_execution_context" type="bool" default="false" />
|
|
<description>
|
|
Execute the string [param code] as JavaScript code within the browser window. This is a call to the actual global JavaScript function [code]eval()[/code].
|
|
If [param use_global_execution_context] is [code]true[/code], the code will be evaluated in the global execution context. Otherwise, it is evaluated in the execution context of a function within the engine's runtime environment.
|
|
</description>
|
|
</method>
|
|
<method name="force_fs_sync">
|
|
<return type="void" />
|
|
<description>
|
|
Force synchronization of the persistent file system (when enabled).
|
|
[b]Note:[/b] This is only useful for modules or extensions that can't use [FileAccess] to write files.
|
|
</description>
|
|
</method>
|
|
<method name="get_interface">
|
|
<return type="JavaScriptObject" />
|
|
<param index="0" name="interface" type="String" />
|
|
<description>
|
|
Returns an interface to a JavaScript object that can be used by scripts. The [param interface] must be a valid property of the JavaScript [code]window[/code]. The callback must accept a single [Array] argument, which will contain the JavaScript [code]arguments[/code]. See [JavaScriptObject] for usage.
|
|
</description>
|
|
</method>
|
|
<method name="pwa_needs_update" qualifiers="const">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if a new version of the progressive web app is waiting to be activated.
|
|
[b]Note:[/b] Only relevant when exported as a Progressive Web App.
|
|
</description>
|
|
</method>
|
|
<method name="pwa_update">
|
|
<return type="int" enum="Error" />
|
|
<description>
|
|
Performs the live update of the progressive web app. Forcing the new version to be installed and the page to be reloaded.
|
|
[b]Note:[/b] Your application will be [b]reloaded in all browser tabs[/b].
|
|
[b]Note:[/b] Only relevant when exported as a Progressive Web App and [method pwa_needs_update] returns [code]true[/code].
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<signals>
|
|
<signal name="pwa_update_available">
|
|
<description>
|
|
Emitted when an update for this progressive web app has been detected but is waiting to be activated because a previous version is active. See [method pwa_update] to force the update to take place immediately.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
</class>
|