Option Types
In an interactive story, choices are the primary way players influence the narrative. They allow players to shape their character's personality and determine the path of the story.
Currently, there are three types of options available for use in your scripts:
Normal Option
This is the standard choice type. A Normal Option is free for the player to select. It allows for branching storylines or character expression without any currency barriers or restrictions.
Syntax:
-> [OptionText]
Parameters:
| Parameter | Type | Description |
|---|---|---|
| OptionText | text | The text displayed on the choice button. |
Examples:
What do you want to order?
-> Sushi
-> Pasta
-> I don't want to order
The player is free to choose any of these three options. None of them require gems or ads.
Premium Option
A Premium Option requires the player to spend in-game currency to make a specific choice. These are typically used for exclusive scenes, romantic interactions, or special advantages that enhance the gameplay experience.
Currently, the system supports gem as the currency type.
Once a Premium Option is purchased, it is permanently unlocked. If the player replays the story, this choice will appear as a Normal Option and will not require payment again.
Syntax:
To create a premium option, add a hashtag followed by the cost definition at the end of the option line. Note the underscore _ separating the currency type and the amount.
-> [OptionText] #cost:[Currency]_[Amount]
Parameters:
| Parameter | Type | Description |
|---|---|---|
| OptionText | text | The text displayed on the choice button. |
| Currency | text | The type of currency used (currently gem is supported). |
| Amount | number | The cost value. This must be separated from the currency by an underscore _. |
When a player clicks a Premium Option:
- Sufficient Funds: If the player has enough currency, the cost is deducted, and the story proceeds immediately.
- Insufficient Funds: A pop-up window appears informing the player they do not have enough currency to choose this option.
Examples:
What do you want to order?
-> Sushi
-> Pasta #cost:gem_10
-> I don't want to order
The player can freely choose "Sushi" or "I don't want to order." However, choosing "Pasta" will deduct 10 gems from their balance.
Ads Option
An Ads Option allows the player to unlock a special choice by watching a rewarded video advertisement. This is an excellent alternative for players who may not have premium currency but still wish to access special content.
Similar to Premium Options, once an Ads Option is watched, it is permanently unlocked. Upon replaying the story, it will function as a Normal Option.
Syntax:
To make an option require an ad, use the #cost:ads tag at the end of the line.
-> [OptionText] #cost:ads
Parameters:
| Parameter | Type | Description |
|---|---|---|
| OptionText | text | The text displayed on the choice button. |
| cost:ads | tag | The specific tag that triggers the video ad logic. |
- On Mobile: The game checks for ad availability. If an ad is ready, the player watches it to unlock the choice. If no ad is available (e.g., due to connection issues), the game will automatically grant the choice to prevent the player from getting stuck.
- In the Editor: Since real ads cannot play in the Unity Editor, a pop-up window will appear confirming that the "Watch Ad" logic was triggered successfully.
Examples:
What do you want to order?
-> Sushi #cost:ads
-> Pasta #cost:gem_10
-> I don't want to order
In this scenario:
- Choosing Sushi triggers a video ad.
- Choosing Pasta costs 10 gems.
- Choosing I don't want to order is free.