Collectables

Collectables #

What are Collectables? #

Collectables are used to automatically reward players for collecting or completing something in your game. Collectables are nested into three layers, each with their own set of rewards. This allows you to set up a wide range of Collectables across different maps or areas of your game. These layers are called Collectables, Item Groups, and Items, where Items are the actual things being collected by the player. Collectables and Item Groups need to be created first before creating an Item.

Collectables are very similar to Triggers in that you trigger them by a defined Name and grant the player a Reward. The major difference between Collectables and Triggers is that Collectables are returned to your game from the API, unlike Triggers that only return the specific Trigger in question.

Create a Collectable #

To create a Collectable, click the Add Collectable button in the Collectables Menu and give your Collectable a name. Each Collectable contains the following information:

Name: The name of the Collectable.

Grants All: If selected, all listed Rewards will be granted to the player when all Items within the Item Groups have been completed. Otherwise a random reward from the list will be selected and granted.

Collectable Rewards: The Reward(s) granted to the player when all Item Groups within the Collectable have been collected.

Add Group: Create an Item Group within this Collectable.

Collectable Rewards #

Click Add Reward to select an Asset, or several Assets, that are granted when a player has completed all Item Groups within this Collectable.

Item Groups #

Item Groups are a way to group many Items together with a linked Reward. For example, you might want to reward the player when they have collected all the Items in a single map. In this case, you would create an Item Group for each map, with the Items in the map nested inside the Item Group. Each Item Group contains the following information:

Group Name: The name of the Item Group.

Grants All: If selected, all listed Rewards will be granted to the player when all Items within the Item Group have been collected. Otherwise a random reward from the list will be selected and granted.

Group Rewards: The Reward(s) granted to the player when all Items within the Item Group have been collected.

Add Item: Create a Collectable Item within this Item Group.

Item Group Rewards #

Click Add Reward to select an Asset that is granted when a player has collected all Items within the Item Group.

Items #

Items are the actual thing being collected by the player. To add an Item to an Item Group, click the Add Item button. Each Item contains the following information:

Name: The name of the Item.

Grants All: If selected, all listed Rewards will be granted to the player when the Item has been collected. Otherwise a random reward from the list will be selected and granted.

Item Rewards: The Reward(s) granted to the player when the Item has been collected.

Item Rewards #

Click Add Reward to select an Asset that is granted when a player has collected this Item.