Version: 2017.1 (switch to 2017.2b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Application.ExternalCall

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function ExternalCall(functionName: string, params args: object[]): void;
public static void ExternalCall(string functionName, params object[] args);

Parameters

functionName Name of the function to call.
args Array of arguments passed in the call.

Description

Calls a function in the web page that contains the WebGL Player.

ExternalCall calls functionName in the web page containing the WebGL player, passing the given arguments to it. Supported argument types are the primitive types (string, int, float, string) and arrays of such types. Any other objects are converted to string using ToString and passed as strings.

The function is non-blocking; ExternalCall immediately returns without waiting for the function that was called to complete.

The number of passed arguments can be varying:

#pragma strict
// Calls MyFunction1 in the web page with no arguments
Application.ExternalCall("MyFunction1");
// Calls MyFunction2 in the web page with a string
Application.ExternalCall("MyFunction2", "Hello from Unity!");
// Calls MyFunction3 in the web page with several arguments of different types
Application.ExternalCall("MyFunction3", "one", 2, 3.0F);
using UnityEngine;

public class ExampleClass : MonoBehaviour { void Example() { // Calls MyFunction1 in the web page with no arguments Application.ExternalCall("MyFunction1"); // Calls MyFunction2 in the web page with a string Application.ExternalCall("MyFunction2", "Hello from Unity!"); // Calls MyFunction3 in the web page with several arguments of different types Application.ExternalCall("MyFunction3", "one", 2, 3.0F); } }

The functions to be called are declared in the HTML page using standard syntax, for example:

// This should be contained in the host page in the appropriate <script> element.
// Using the above call from Unity, this will receive
// "Hello from Unity!" as the argument.
function MyFunction2( arg )
{
    alert( arg );
}