Getting Started
Getting Started
Samples & Examples
Core Concepts & Glossary
Unity Package Types
Spaces & Space Templates
Custom Avatars
Custom Avatar Animations
Avatar Attachments
Custom Prefab Objects
Components
‣
‣
Quests and Rewards
Drivable Vehicles
Economy
Economy Overview
Monetization
Items
Consumable Items
Rewarding Items
World Currency
Selling Items
Scripting
‣
Guidelines
Supported Features and Limitations
Performance Guidelines
Lighting
Publishing to Spatial
Finding Published Packages
Support
FAQs
Help and Community
Release Notes
Asset Import Settings
Quests and Rewards
This is an experimental component, It is likely to receive large changes in the future!
A quest is a journey taken in order to fulfill a certain goal or objective, involving a series of tasks along the way. Quest serve as a way to create a compelling story or adventure for your users. The goal of a quest can range from the discovery of treasure, the rescue of a captive, or the defeat of a powerful enemy, and the obstacles encountered along the way can test the skills, courage, and determination of the quest-taker.
Rewards
Users can be rewarded when finishing quests with 
Badges
Quest Properties
On Started Event | Event that is triggered when the quest has started. |
Tasks | List of tasks that must be completed to complete the quest. See Task Properties section. |
Property | Function |
Quest Name | Name of the quest |
Quest Description | Short description of what the quest objective is |
Start Automatically | Setting this on starts the quest automatically. There can only be one active quest at a time |
Save User Progress | When turned on, the user’s progress on quests and individual tasks is preserved between sessions.
If you want users to be able to “restart” a quest, you can simply trigger the “Reset Quest” and “Start Quest” events. |
Tasks Are Ordered | If true, only the first task will be started and once it’s completed, the next task will start. If false, all tasks are automatically started when the quest completes. |
Celebrate On Complete | If true, the quest plays a confetti celebration animation when the quest is completed. |
Quest Rewards | Rewards to be given when the quest is completed. There are two reward types: Badges and Items. Badges |
On Completed Event | Event that is triggered when the quest has finished. |
On Previously Completed Event | Event that is triggered when the user loads into a space where a quest was previously completed. Only used when “Save User Progress” is set to true.
This event allows you to “fast forward” any settings in the scene that should be enabled if a quest was previously completed. |
On Reset Event | Event that is triggered when quest is reset. |
Task Properties
On Started Event | Event that is triggered when the task is started. |
Property: | Function |
Name | Displayed name of the task |
Type | - Check: The task can be completed by doing one action.
- Progress Bar: The task can be completed by doing a number of actions specified in Progress Steps |
Progress Steps | Number of times the task has to be. Only used if task type is Progress Bar |
Task Markers | Display on-screen markers that guide the user to a specific location. |
On Completed Event | Event that is triggered when the certain task is completed; |
On Previously Completed Event | Same as Quest “On Previously Completed Event”. See quest properties |
How to start a quest
There are two ways to start a quest:
- Set the quest to start automatically (only one quest can be started automatically on a space)
- Call the quest event “Start Quest”. This is accessed thru any Spatial Event available via ,Trigger Event, andPoint Of Interest.Interactable
How to progress a quest
You can trigger a quest task to complete or progress through Quest Events. These can be triggered through any Spatial Event available via , Trigger Event, and Point Of Interest.Interactable
How to restart a quest
Use a or Trigger Event to trigger an event that resets and restarts a quest like this:Interactable
Examples
An Interactable that completes a Quest Task
In this example, we created an that:Interactable
- triggers an open animation
- completes the “Open the door” task on our quest
A Trigger that adds progress to a Quest Task
This second example shows a . Entering this trigger willTrigger Event
- disable the trigger to prevent repeat events
- add task progress to the “Find the 3 orbs” task
There are 2 additional copies of this game object in the scene.
Once a users finds all 3 objects the task will complete.
Add a Task Marker
Quest Rewards
Quests currently have two types of rewards:
- Badges: These are like Achievements (See )Badges
- Items: These are things the user can own
To award an item to a user for completing a quest, simply add a reward to the Spatial Quest component, select reward type Item and enter the ItemID for the item you want to reward.
To award a badge, simply select “Badge” as the reward type and then select the badge from the drop-down menu.
Badges
← Previous
Next →
