summaryrefslogtreecommitdiff
path: root/doc/classes/JavaScript.xml
blob: 7737001a6cf6518c69daa2bd39c55d31b40fad46 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<?xml version="1.0" encoding="UTF-8" ?>
<class name="JavaScript" inherits="Object" category="Core" version="3.2">
	<brief_description>
		Singleton that connects the engine with the browser's JavaScript context in HTML5 export.
	</brief_description>
	<description>
		The JavaScript singleton is implemented only in the HTML5 export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs.
	</description>
	<tutorials>
		<link>https://docs.godotengine.org/en/latest/getting_started/workflow/export/exporting_for_web.html#calling-javascript-from-script</link>
	</tutorials>
	<methods>
		<method name="eval">
			<return type="Variant">
			</return>
			<argument index="0" name="code" type="String">
			</argument>
			<argument index="1" name="use_global_execution_context" type="bool" default="false">
			</argument>
			<description>
				Execute the string [code]code[/code] as JavaScript code within the browser window. This is a call to the actual global JavaScript function [code]eval()[/code].
				If [code]use_global_execution_context[/code] 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>
	</methods>
	<constants>
	</constants>
</class>