Develop Cloud Code modules in the Unity Editor

Author Cloud Code modules (.ccmu) entirely within the Unity Editor.

Read time 2 minutes

Last updated 25 days ago

Important

This page describes an experimental feature that might change significantly before release. It's not recommended to use or rely on experimental features in production environments due to potential instability.

You can create, compile, and deploy Cloud Code modules entirely within the Unity Editor. A module created in this way is called a Unity Cloud Code module (UCCM), and its asset file carries the .ccmu extension. UCCMs bring the entire module workflow into the Editor, automating some processes and improving iteration time. The same logic and concepts of the legacy Cloud Code modules still apply, with the following additional key features:

Develop Cloud Code modules using the standard Unity Editor script workflow. Scripts are created and compiled directly in the Editor, but their contents are edited in your currently configured External Script Editor.
Unity Cloud Code modules compile automatically during the standard Editor compilation pass, without having to manually generate bindings.
Debugging is built-in by default and integrated into the Editor.

Create a Unity Cloud Code module

You can create a new UCCM directly within the Unity Editor. To create a Unity Cloud Code module:

In the Project window, select or create a folder to contain your module.
Right-click in the folder, then select Create > Services > Cloud Code Module Script. The Cloud Code Script appears in your folder.
Optionally rename the script, then press Enter to accept the script.
In the Cloud Code Module Creator dialog that opens, select the Cloud tab, where you can do the following:
- In the Cloud Code Script field, optionally rename the C# script.
- In the Cloud Code C# Module field, optionally rename the module.
Verify the remaining paths and file names for the other resources in the Cloud and Client tabs.
Select Confirm.
If required, repeat steps 1 to 3 to create another script. Creating a script in the same folder automatically adds it to the module.

The module now appears in the Deployment window as a Cloud Code Module. From the Deployment window, you can deploy the module to a remote server or to a local Cloud Code server if you have one running.

Tip

When testing Stateful Cloud Code on a local server, you can reset persistent states directly from within the Cloud Code Toolbar button to return your game to its default state.

The previous procedure generates the following:

A
```
Cloud
```
folder containing a Cloud Code script and an Assembly Definition. Write your module logic here. You can add more scripts to this folder.
A
```
Client
```
folder containing a client script and an Assembly Definition. This client script is an empty partial class containing a reference to a generated file that's updated automatically from your Cloud Code scripts.
A Unity Cloud Code module asset (.ccmu) in the parent folder, pointing to both Assembly Definitions. Use this file to deploy the module in the Deployment window.

Warning

The Client classes are partial classes because Cloud Code uses source generation to create client-side bindings for your game to call cloud functions. Because the Client script is automatically generated, don't modify it directly, as doing so can break your game.

Documentation

Development

User Acquisition

Monetization

Industry