Documentation

Support

Cloud Code

Use modules

Use scripts

Use Triggers

Open Unity Dashboard

Cloud Code

Cloud Code JavaScript files

Manage your Cloud Code scripts from the Unity Editor using script files and the Deployment package.
Read time 2 minutesLast updated a day ago
Use Cloud Code JavaScript files to manage your scripts from the Unity Editor. You can deploy these scripts to the Unity Dashboard using the Deployment package.

Prerequisites

To use Cloud Code scripts, you must install the Deployment package (
com.unity.services.deployment
).

Create Cloud Code script files

To create a Cloud Code script file:
  1. In the Unity Editor, right-click the Project window and select Create > Services > Cloud Code Js Script.

File format

The file format follows .js standards.

Example

/* *  -------- Example Cloud Code Script -------- * *  Roll a 6-sided dice and get back the result * * -------------------------------------------- * Additional imports are limited to: *  - lodash-4.17 *  - axios-0.21 *  - @unity-services/cloud-save-1.0 *  - @unity-services/economy-2.0 *  - @unity-services/remote-config-1.0 */// Include the lodash module for convenient functions such as "random"const _ = require("lodash-4.17");const NUMBER_OF_SIDES = 6;/* * CommonJS wrapper for the script. It receives a single argument, which can be destructured into: *  - params: Object containing the parameters provided to the script, accessible as object properties *  - context: Object containing the projectId, environmentId, environmentName, playerId and accessToken properties. *  - logger: Logging client for the script. Provides debug(), info(), warning() and error() log levels. */module.exports = async ({ params, context, logger }) => {  // Log an info message with the parameters provided to the script and the invocation context  logger.info("Script parameters: " + JSON.stringify(params));  logger.info("Authenticated within the following context: " + JSON.stringify(context));  const roll = rollDice(NUMBER_OF_SIDES);  if (roll > NUMBER_OF_SIDES) {    // Log an error message with information about the exception    logger.error("The roll is greater than the number of sides: " + roll);    // Return an error back to the client    throw Error("Unable to roll dice!");  }  // Return the JSON result to the client  return {    sides: NUMBER_OF_SIDES,    roll: roll,  };};// Functions can exist outside of the script wrapperfunction rollDice(sides) {  return _.random(1, sides);}
For more authoring options, refer to Write scripts in Editor.

Deploy files

When you've created your Cloud Code script files, you can deploy them to your chosen environment. To deploy a file:
  1. In the Unity Editor, select Services > Deployment. For Unity Versions earlier than 2022, select Window > Deployment. The Deployment window displays your local Cloud Code script files.
  2. Select your chosen Cloud Code script files and select Deploy Selected.
You can now edit your Cloud Code script in the Unity Dashboard. For more information on working with the Deployment window, refer to Deployment package.