Unity Cloud Dashboard#

The Unity Cloud Dashboard is a simple way to get started as it allows you to take full control of your triggers through a graphical interface. This section covers how you can preview, create and delete your triggers.

Preview triggers#

You can access a list of all triggers for an environment from the Unity Cloud Dashboard:

1. In the Unity Cloud Dashboard, select Cloud Code.
2. Select Triggers.
3. Select an environment from the list of environments.

A list of all triggers in the selected environment for the project appears. The table contains the name, trigger, type, and last updated timestamp.

Trigger details#

You can navigate to the trigger details page by selecting a trigger from the list of triggers. The trigger details page shows you the following information:

The trigger definition card shows a breakdown of the trigger configuration:

• when this happens (event type)
• where (filters)
• do this (action, Cloud Code script or module)

The filters are displayed in a chips, showing the attribute, operator, and value of the filter. If the dashboard can't display the filter in the chip format, the dashboard displays the filter in its original CEL format.

Navigate to logs#

To navigate to the logs page for trigger and view the logs for the trigger execution, select the View Trigger Logs button. Learn more about logs in the Logs section.

Navigate to action#

If the trigger is associated with an existing script or module, the trigger definition card provides a link to the script or module. To navigate to the script or module details page, select the link.

Create a trigger#

You can create an event-based trigger in the Unity Cloud Dashboard.

1. In the Unity Cloud Dashboard, select Products > Cloud Code.

2. Select Triggers.

3. Select New trigger.

4. Fill in the following information:

   • Name: A name for your trigger, used to identify the configuration. Trigger names must be unique across the project and environment and not exceed 255 characters.
   • Type: The type of the trigger. Event-based triggers refer to triggers triggered by UGS-emitted events.

5. Select Next.

6. In the next step, select the following information:

   • In the When this happens section:

     1. Select the Add Trigger Event button.

     2. Select the event you want to trigger the script.

     3. Select Add Filter to add a filter to the event.

     Note: You do not need to encase the string values for quotes. However, you must encase the values for JSON types in quotes.

   • In the Do this section:

     1. Select the Add Action dropdown.

     2. Select the action you want to perform when the trigger is activated. This action can be a script or a module.

     Note: You can only select Cloud Code actions that are in the same environment as the trigger. If you selected a Moderation event in the When this happens section and want to a select script for your action, you can only select a Moderation script.

7. Select Confirm.

Trigger creation redirects you to the trigger list page. To inspect the trigger configuration, select the trigger name in the table.

Filters in the Unity Cloud Dashboard#

You can add filters to the trigger configuration to specify the conditions under which the trigger activates. The Unity Cloud Dashboard supports a limited set of filters that you can use to filter the event payload.

Familiarize yourself with how filters work in the Filters section. Refer to Supported UGS events to inspect event payloads for each UGS event.

Supported operators#

The Unity Cloud Dashboard displays different operators depending on the attribute type:

Join filters#

You can define up to 10 filters for a trigger. You can join filters by the logical operators AND and OR. You can use these operators to combine multiple filters to create complex conditions.

Define filters with the Cloud Save key-saved event#

You can define your trigger to only activate when a specific key is saved in Cloud Save. For example, you can define a filter to only activate the trigger when the key playerData is saved.

In the Unity Cloud Dashboard, you can add this filter to the trigger configuration:

1. In the When this happens section, select the Add Event button.
2. Select the event dropdown and choose the Cloud Save key-saved event.
3. Select the Add Filter button.
4. In the new Filter card:
   1. In the first dropdown, select the key attribute.
   2. In the second dropdown, select the equals to operator.
   3. In the third dropdown, enter the value playerData.

If you define this filter, you ensure that the trigger only activates when the key playerData is saved in Cloud Save.

Define filters with the Leaderboards score-submitted event#

You can define your trigger to only activate when a specific score is submitted to a leaderboard. For example, you can define filters to only activate the trigger for a score in a specific range.

In the Unity Cloud Dashboard, you can add this filter to the trigger configuration:

1. In the When this happens section, select the Add Event button.
2. Select the event dropdown and choose the Leaderboards score-submitted event.
3. Select the Add Filter button.
4. In the new Filter card:
   1. In the first dropdown, select the score attribute.
   2. In the second dropdown, select the greater than operator.
   3. In the third dropdown, enter the value 0.
5. Select the Add Filter button.
6. In the new Filter card:
   1. In the first dropdown, select the score attribute.
   2. In the second dropdown, select the less than operator.
   3. In the third dropdown, enter the value 100.

If you define this filter, you ensure that the trigger only activates when a score between 0 and 100 is submitted to a leaderboard.

Delete a trigger#

To delete triggers from the Unity Cloud Dashboard:

1. Navigate to the Triggers list page.
2. Select the bin icon. A dialog appears to warn you that trigger deletion can't be undone.

   Note: If you delete a trigger that is in use by a live game, you may cause unexpected behavior in your game.

3. Select Delete to confirm the deletion.

Alternatively, you can navigate to the trigger details page and select the Delete button to delete the trigger.