Unlockables #
Unlockables are a Hiro meta system which allows the player to unlock rewards in the game. The rewards can be anything from a new character, a new weapon, or anything relevant for your game. Unlockables can be unlocked by the player by waiting for a period of time or by watching a rewarded video.
You can configure unlockables so that players only have a limited number of slots for active unlockables at any time, and also provide players the ability to purchase extra slots to store more unlockables, up to a maximum limit.
Customization parameters #
All unlockables and their configuration is done through a JSON definition.
The following JSON represents the customization parameters you can use to configure the default user experience for the Unlockables system.
|
|
Unlockable slots #
Property | Subproperty | Description |
---|---|---|
max_active_slots | The maximum number of slots a player can have active at any time. | |
active_slots | The number of active slots, if any, each player starts with. | |
slots | The total number of slots, active and inactive, a player can have. | |
slot_cost | The cost to purchase additional active slots. | |
currencies | A string:int dictionary of the currencies and amounts required to purchase additional slots. |
Unlockable #
Each unlockable is keyed by id and may define the following properties:
Property | Subproperty | Description |
---|---|---|
probability | An int value indicating the likelihood this unlockable item is the one received by the player. | |
name | The name of this unlockable. | |
category | The category, if any, of this unlockable. | |
description | The description of this unlockable. | |
start_cost | The cost to begin unlocking this unlockable. | |
currencies | A string:int dictionary of the currencies and amounts required as the start cost. | |
wait_time_sec | The total time (in seconds) a player must wait before this item in unlocked. | |
cost | The cost to advance the wait time by one unit of time, defined in cost_unit_time_sec . | |
currencies | A string:int dictionary of the currencies and amounts required. | |
cost_unit_time_sec | The amount of time to be advanced on wait_time_sec for each cost purchase. | |
reward | An object that defines what rewards the player should receive after unlocking this unlockable. | |
additional_properties | A string:string dictionary of key value pairs that can contain additional context. |