Window

Displays a dialog with the specified message and an "OK" button. The dialog is non-modal; the script continues without waiting for a user response.

Parameters

Example

Display a friendly greeting.

Window.alert("Welcome!");
print("Script continues without waiting");

Prompts the user to choose a file. Displays a modal dialog that navigates the directory tree.

Parameters

Example

Ask the user to choose an image file.

var filename = Window.browse("Select Image File", Paths.resources, "Images (*.png *.jpg *.svg)");
print("File: " + filename);

Prompts the user to choose an Asset Server item. Displays a modal dialog that navigates the tree of assets on the Asset Server.

Parameters

Example

Ask the user to select an FBX asset.

var asset = Window.browseAssets("Select FBX File", "/", "*.fbx");
print("FBX file: " + asset);

Prompts the user to choose an Asset Server item. Displays a non-modal dialog that navigates the tree of assets on the Asset Server. An assetsDirChanged signal is emitted when an asset is chosen; no signal is emitted if the user cancels the dialog.

Parameters

Example

function onAssetsDirChanged(asset) {
    print("FBX file: " + asset);
}
Window.assetsDirChanged.connect(onAssetsDirChanged);

Window.browseAssetsAsync("Select FBX File", "/", "*.fbx");
print("Script continues without waiting");

Prompts the user to choose a file. Displays a non-modal dialog that navigates the directory tree. A browseChanged signal is emitted when a file is chosen; no signal is emitted if the user cancels the dialog.

Parameters

Example

Ask the user to choose an image file without waiting for the answer.

function onBrowseChanged(filename) {
    print("File: " + filename);
}
Window.browseChanged.connect(onBrowseChanged);

Window.browseAsync("Select Image File", Paths.resources, "Images (*.png *.jpg *.svg)");
print("Script continues without waiting");

Prompts the user to choose a directory. Displays a modal dialog that navigates the directory tree.

Parameters

Example

Ask the user to choose a directory.

var directory = Window.browseDir("Select Directory", Paths.resources);
print("Directory: " + directory);

Prompts the user to choose a directory. Displays a non-modal dialog that navigates the directory tree. A browseDirChanged signal is emitted when a directory is chosen; no signal is emitted if the user cancels the dialog.

Parameters

Example

Ask the user to choose a directory without waiting for the answer.

function onBrowseDirChanged(directory) {
    print("Directory: " + directory);
}
Window.browseDirChanged.connect(onBrowseDirChanged);

Window.browseDirAsync("Select Directory", Paths.resources);
print("Script continues without waiting");

Gets Interface's build number.

Closes a message box that was opened with openMessageBox.

Parameters

Prompts the user to confirm something. Displays a modal dialog with a message plus "Yes" and "No" buttons.

Parameters

Example

Ask the user a question requiring a yes/no answer.

var answer = Window.confirm("Are you sure?");
print(answer);  // true or false

Copies text to the operating system's clipboard.

Parameters

Displays a notification message. Notifications are displayed in panels by the default script, nofications.js. An announcement signal is emitted when this function is called.

Parameters

Example

Send and capture an announcement message.

function onAnnouncement(message) {
    // The message is also displayed as a notification by notifications.js.
    print("Announcement: " + message);
}
Window.announcement.connect(onAnnouncement);

Window.displayAnnouncement("Hello");

Deprecated: This function is deprecated and will be removed.

Gets the index of the currently active display plugin.

Gets the size of the drawable area of the Interface window if in desktop mode or the HMD rendering surface if in HMD mode.

Gets the number of display plugins currently available.

Gets the name of a display plugin.

Parameters

Example

Print the names of all available display plugins.

for (var i = 0, length = Window.getDisplayPluginCount(); i < length; i++) {
    print(Window.getDisplayPluginName(i));
}

Gets the last domain connection error when a connection is refused.

Gets Interface's user agent.

Checks whether the Interface window has focus.

Checks whether a display plugin is an HMD.

Parameters

Checks to see if physics is active for you in the domain you're visiting - there is a delay between your arrival at a domain and physics becoming active for you in that domain.

Example

Wait for physics to be enabled when you change domains.

function checkForPhysics() {
    var isPhysicsEnabled = Window.isPhysicsEnabled();
    print("Physics enabled: " + isPhysicsEnabled);
    if (!isPhysicsEnabled) {
        Script.setTimeout(checkForPhysics, 1000);
    }
}

function onDomainChanged(domain) {
    print("Domain changed: " + domain);
    Script.setTimeout(checkForPhysics, 1000);
}

Window.domainChanged.connect(onDomainChanged);

Checks if a 2D point is within the desktop window if in desktop mode, or the drawable area of the HUD overlay if in HMD mode.

Parameters

Emits a connectionAdded or a connectionError signal that indicates whether or not a user connection was successfully made using the Web API.

Parameters

Opens an Android activity and optionally return back to the scene when the activity is completed. Android only.

Parameters

Opens a non-modal message box that can have a variety of button combinations. See also, updateMessageBox and closeMessageBox.

Parameters

Example

Ask the user whether that want to reset something.

var messageBox;
var resetButton = 0x4000000;
var cancelButton = 0x400000;

function onMessageBoxClosed(id, button) {
    if (id === messageBox) {
        if (button === resetButton) {
            print("Reset");
        } else {
            print("Don't reset");
        }
    }
}
Window.messageBoxClosed.connect(onMessageBoxClosed);

messageBox = Window.openMessageBox("Reset Something", 
    "Do you want to reset something?",
    resetButton + cancelButton, cancelButton);

Opens a URL in the Interface window or other application, depending on the URL's scheme. The following schemes are supported:

• hifi: Navigate to the URL in Interface.
• hifiapp: Open a system app in Interface.

Other schemes will either be handled by the OS (e.g. http, https, or mailto) or will display a dialog asking the user to confirm that they want to try to open the URL.

Parameters

Opens an Interface web browser window.

Parameters

Prompts the user to enter some text. Displays a modal dialog with a message and a text box, plus "OK" and "Cancel" buttons.

Parameters

Example

Ask the user a question requiring a text answer.

var answer = Window.prompt("Question", "answer");
if (answer === "") {
    print("User canceled");
} else {
    print("User answer: " + answer);
}

Prompts the user to enter some text. Displays a non-modal dialog with a message and a text box, plus "OK" and "Cancel" buttons. A promptTextChanged signal is emitted when the user OKs the dialog; no signal is emitted if the user cancels the dialog.

Parameters

Example

Ask the user a question requiring a text answer without waiting for the answer.

function onPromptTextChanged(text) {
    print("User answer: " + text);
}
Window.promptTextChanged.connect(onPromptTextChanged);

Window.promptAsync("Question", "answer");
print("Script continues without waiting");

Gets the signature for Interface's protocol version.

Raises the Interface window if it is minimized. If raised, the window gains focus.

Prompts the user to specify the path and name of a file to save to. Displays a modal dialog that navigates the directory tree and allows the user to type in a file name.

Parameters

Example

Ask the user to specify a file to save to.

var filename = Window.save("Save to JSON file", Paths.resources, "*.json");
print("File: " + filename);

Prompts the user to specify the path and name of a file to save to. Displays a non-modal dialog that navigates the directory tree and allows the user to type in a file name. A saveFileChanged signal is emitted when a file is specified; no signal is emitted if the user cancels the dialog.

Parameters

Example

Ask the user to specify a file to save to without waiting for an answer.

function onSaveFileChanged(filename) {
    print("File: " + filename);
}
Window.saveFileChanged.connect(onSaveFileChanged);

Window.saveAsync("Save to JSON file", Paths.resources, "*.json");
print("Script continues without waiting");

Sets the currently active display plugin.

Parameters

Sets what to show on the PC display. For entity camera view, the entity camera is configured using Camera.setCameraEntity and Camera.mode.

Parameters

Makes the Interface window have focus. On Windows, if Interface doesn't already have focus, the task bar icon flashes to indicate that Interface wants attention but focus isn't taken away from the application that the user is using.

Prepares a snapshot ready for sharing. A snapshotShared signal is emitted when the snapshot has been prepared.

Parameters

Opens the Asset Browser dialog. If a file to upload is specified, the user is prompted to enter the folder and name to map the file to on the asset server.

Parameters

Example

Upload a file to the asset server.

var filename = Window.browse("Select File to Add to Asset Server", Paths.resources);
print("File: " + filename);
Window.showAssetServer(filename);

Takes a 360° snapshot at a given position for the secondary camera. The secondary camera does not need to have been set up.

Snapshots are saved to the path specified in Settings > General > Snapshots, which can be accessed via the Snapshot API.

Parameters

Takes a still snapshot of the current view from the secondary camera that can be set up through the Render API.

Snapshots are saved to the path specified in Settings > General > Snapshots, which can be accessed via the Snapshot API.

Parameters

Takes a snapshot of the current Interface view from the primary camera. When a still image only is captured, stillSnapshotTaken is emitted; when a still image plus moving images are captured, processingGifStarted and processingGifCompleted are emitted.

Snapshots are saved to the path specified in Settings > General > Snapshots, which can be accessed via the Snapshot API.

Parameters

Example

Using the snapshot function and signals.

function onStillSnapshotTaken(path, notify) {
    print("Still snapshot taken: " + path);
    print("Notify: " + notify);
}

function onProcessingGifStarted(stillPath) {
    print("Still snapshot taken: " + stillPath);
}

function onProcessingGifCompleted(animatedPath) {
    print("Animated snapshot taken: " + animatedPath);
}

Window.stillSnapshotTaken.connect(onStillSnapshotTaken);
Window.processingGifStarted.connect(onProcessingGifStarted);
Window.processingGifCompleted.connect(onProcessingGifCompleted);

var notify = true;
var animated = true;
var aspect = 1920 / 1080;
var filename = "example-snapshot";
Window.takeSnapshot(notify, animated, aspect, filename);

Updates the content of a message box that was opened with openMessageBox.

Parameters

Triggered when a message is announced by displayAnnouncement.

Parameters

Triggered when the user chooses an asset in a browseAssetsAsync dialog.

Parameters

Triggered when the user chooses a file in a browseAsync dialog.

Parameters

Triggered when the user chooses a directory in a browseDirAsync dialog.

Parameters

Triggered when you've successfully made a user connection.

Parameters

Triggered when you failed to make a user connection.

Parameters

Triggered when you change the domain you're visiting.

Warning: Is not emitted if you go to a domain that isn't running.

Parameters

Example

Report when you change domains.

function onDomainChanged(domain) {
    print("Domain changed: " + domain);
}

Window.domainChanged.connect(onDomainChanged);

Triggered when you try to visit a domain but are refused connection.

Parameters

Triggered when the position or size of the Interface window changes.

Parameters

Example

Report the position of size of the Interface window when it changes.

function onWindowGeometryChanged(rect) {
    print("Window geometry: " + JSON.stringify(rect));
}

Window.geometryChanged.connect(onWindowGeometryChanged);

Triggered when the interstitial mode changes.

Parameters

Triggered when the user closes a message box that was opened with openMessageBox.

Parameters

Triggered when "minimized" state of the Interface window changes.

Parameters

Example

Report the "minimized" state of the Interface window when it changes.

function onWindowMinimizedChanged(minimized) {
    print("Window minimized: " + minimized);
}

Window.minimizedChanged.connect(onWindowMinimizedChanged);
     

Triggered when a GIF has been prepared of the snapshot images captured by takeSnapshot.

Parameters

Triggered when the snapshot images have been captured by takeSnapshot and the GIF is starting to be processed.

Parameters

Triggered when the user OKs a promptAsync dialog.

Parameters

Triggered when you try to visit a domain but are redirected into the error state.

Parameters

Triggered when the user specifies a file in a saveAsync dialog.

Parameters

Triggered when a still 360° snapshot has been taken by calling takeSecondaryCamera360Snapshot.

Parameters

Triggered when a snapshot submitted via shareSnapshot is ready for sharing. The snapshot may then be shared via the Account.metaverseServerURL Web API.

Parameters

Triggered when a still snapshot has been taken by calling takeSnapshot with includeAnimated = false or takeSecondaryCameraSnapshot.

Parameters

Triggered when you try to navigate to a *.json, *.svo, or *.svo.json URL in a Web browser within Interface.

Parameters