# Get Started with Scripting¶

Many of the scripts in Vircadia run behind the scenes, so that you don't even know they're running. However, if you want to create some advanced behavior, you may need to write your own scripts to make sure everything works correctly.

This page ensures that you know what type of script to use and helps you get started running your own simple scripts.

Vircadia scripting runs on a JavaScript engine that is provided with Qt.

Nota

Note that any functionality that runs around web pages (such as cookies, local storages, or databases) does not work with 3D environments such as Vircadia. For this reason, you cannot use JavaScript frameworks such as Angular, React, Express, jQuery, Vue, etc.

You are likely to interface most with these Vircadia APIs:

API(s)

Descripción

Entities

Lets you manipulate the entities around you, as long as you have permissions to do so. This means you can add, remove, and edit entities. Everyone has access to get properties of an entity, and can be used to find Entities in range, direction, collision, or raytrace.

AvatarList

AvatarManager

MyAvatar

Lets you get information on an Avatar, or manipulate your own client-only MyAvatar. The information here will be always the avatar information of the client running the script. AvatarList and AvatarManager are basically the same.

Script

Lets you to connect callbacks from your client to script, such as functionality that is dependent on time (Script.update, Script.setTime, Script.setInterval etc), connect paths relatively to Assets (Script.relativePath), refer to other scripts (Script.include), or create events which occur when the script is turned off (Script.scriptEnding).

There are many other APIs available, and we encourage you to make sure use of them as you become more comfortable scripting in Vircadia.

## Types of Scripts¶

Script Type

Descripción

Interface Script

Interface scripts run as long as you have Interface running. With these scripts, you can perform one-time creation tasks or modify the user experience with new menus, overlays, tweaks, plugins, and extensions.

Assignment Client Script

Assignment client scripts coordinate the actions between entities and avatars in your domain. These scripts continue to run even when you shut down Interface.

Avatar Script

Avatar scripts run on an avatar and can give it unique effects, such as flowing hair.

Client Entity Script

Client entity scripts are scripts attached to entities that run locally in response to a user in a domain. With these scripts, you can customize what happens when a user encounters an entity.

Server Entity Script

Server entity scripts are scripts attached to entities that do not require a user to trigger. These scripts control entities so that their behavior is seen and heard by everyone in the domain.

## Scripting Permissions¶

Each domain owner has the ability to restrict create and edit permissions. If the script you want to run adds or edits entities and you don't have the permission to do so, you won't see any objects created or changed. However, you will still see the script listed in the Running Scripts window.

## Running Scripts Window¶

The Running Scripts window can be used to load, run and stop scripts from a URL or from a disk drive. Vircadia also provides a number of sample scripts for you to try out.

To open the Running Scripts window, go to Edit > Running Scripts or press Ctrl + J on your keyboard.

## Sample Scripts¶

Vircadia comes with a collection of scripts designed to improve your experience as a user and provide tools for developing your own content. We encourage you to look at these scripts as a resource to learn how to code your own.

Nota

Loading (or running) a script lets you test the functionality and see how it behaves. If you want to view the actual code, you will need to open the file in the text editor of your choice. In the 'Running Scripts' window, click the 'Reveal Scripts' folder and browse to the JavaScript file that you want to view.

These are the scripts we have available:

Scripts Folder

Descripción

android

These scripts were built to run on Android devices.

developer

These scripts were created for internal use and debugging, but are available as advanced developers may find them useful when creating content. These scripts are not "entry-level" and are not guaranteed to work or be documented.

modules

These scripts create external tools that simplify scripting in Vircadia. For example, the AppUI module helps you create a tablet app, while the Request module processes HTTP requests.

system

These scripts are critical to the stability and usability of Vircadia. Making changes to these scripts is not recommended, nor is it easy, as you may need 'administrative' privileges.

tutorials

These scripts provide examples of what you can do using scripts in Vircadia. Examples include: creating butterflies, making your avatar clap, and adding ambient sound to your domain.

### Load and Run a Script¶

To run a script:

1. Open the 'Running Scripts' window.

2. For scripts hosted in the cloud, click 'From URL'. Enter the URL of your script file and click 'OK'.

3. For scripts on your local computer, click 'From Disk'. Browse to your script file and click 'Open'.

4. To load a sample script, browse to the script at the bottom of the 'Running Scripts' window.

### Reload or Stop a Script¶

To reload or stop a script, open the 'Running Scripts' window and do one of the following:

• To reload all running scripts, click the 'Reload All' button at the top of the 'Running Scripts' window.

• To reload a specific script, click the circular arrow next to the script.

• To stop all running scripts, click the 'Stop All' button at the top of the 'Running Scripts' window.

• To stop a specific script, click the 'X' next to the script.

### Add a Script to the Default Scripts¶

You can add a script to the default scripts to run every time you start Interface.

• In Interface, pull up your Tablet or HUD and go to Menu > Edit > Running Scripts.

• Click 'Reveal Scripts Folder' at the bottom.

• In the file explorer window, open the 'defaultScripts.js' file.

• Add your script to this file to make it run with other default scripts. Ensure the folder path to your script is correct.

Nota

The 'defaultScripts.js' file is updated every time you update Interface to the latest release version. This means that any changes you make to the file will be overwritten. You can avoid this by writing and running a 'loader' script to load scripts on start up.

## Scripting Console¶

The Scripting Console lets you test and run short script snippets quickly in Vircadia to see how they work. To open the console, go to the 'Developer menu', then Scripting > Console. If the 'Developer' menu is not visible, first go to the 'Settings' menu and click 'Developer' Menu.

## Debug Window¶

The Debug Window shows the output generated by your running scripts. This lets you watch the script(s) in action and make sure that it is running as you intended. If the script fails, the debugger can help you identify what went wrong, and point you to specific lines of code where the error occurred. To open the Debug Window, go to the 'Developer' menu, then Scripting > Script Log (HMD Friendly). If the Developer menu is not visible, first go to the 'Settings' menu and click 'Developer' Menu.

Ver también