Base

Read more about the Base system in Hiro here.

In-App Purchases #

UnityPurchasingSystem integrates Unity Purchasing with the Hiro economy system, handling product registration, receipt validation via Nakama, and reward delivery automatically.

Initialize: Add UnityPurchasingSystem to your system list after EconomySystem. On initialization, it reads all SKU-based store items from the economy config and registers them with Unity Purchasing automatically.
Purchase: Call BuyProductAsync(storeItem) or BuyProductByIdAsync(id) to initiate a platform purchase. The system submits the receipt to Nakama for server-side validation and resolves only after the reward has been granted.
Handle failures: Both buy methods throw PurchaseFailureException on failure. Use the Reason property to handle user cancellations, payment declines, and other error cases.
Restore purchases: Call RestorePurchasesAsync() to restore non-consumable purchases on iOS, as required by App Store guidelines. No-op on Android and other platforms.

For code examples and a complete implementation walkthrough, see How to implement IAPs in Unity.

App rating #

You can let the user rate your application using the NakamaSystem’s RateAppAsync function which will trigger a feedback email to whichever email address is configured on the server.

1
2
3
var score = 5;
var message = "I love this game!";
await nakamaSystem.RateAppAsync(score, message);

Push notifications #

Initialize the UnityMobileNotificationsSystem #

The UnityMobileNotificationsSystem constructor takes an ILogger and a bool that controls whether notification permissions are requested on initialization.

1
2
var mobileNotificationsSystem = new UnityMobileNotificationsSystem(logger, requestPermissionOnInitialize: true);
systems.Add(mobileNotificationsSystem);

Observing systems #

Some Hiro systems can be observed by the UnityMobileNotificationsSystem to automatically schedule relevant notifications.

You can customise the notification titles and messages if you would like, as seen below:

Achievements System #

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
var achievementsSystem = this.GetSystem<AchievementsSystem>();
var unityMobileNotificationsSystem = this.GetSystem<UnityMobileNotificationsSystem>();
var messages = new AchievementsNotificationMessages
{
    RepeatAvailableFunc = achievement => new NotificationMessage
    {
        Title = "Repeat achievement available!",
        Body = $"The repeat achievement '{achievement.Name}' is available."
    }
};
unityMobileNotificationsSystem.ObserveSystem(achievementsSystem, messages);

Unlockables System #

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
var unlockablesSystem = this.GetSystem<UnlockablesSystem>();
var unityMobileNotificationsSystem = this.GetSystem<UnityMobileNotificationsSystem>();
var messages = new UnlockablesNotificationMessages
{
    ClaimAvailableFunc = unlockable => new NotificationMessage
    {
        Title = "Unlockable reward available!",
        Body = $"The reward for the unlockable '{unlockable.Name}' is available to claim."
    }
};
unityMobileNotificationsSystem.ObserveSystem(unlockablesSystem, messages);

Energies System #

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
var energiesSystem = this.GetSystem<EnergiesSystem>();
var unityMobileNotificationsSystem = this.GetSystem<UnityMobileNotificationsSystem>();
var messages = new EnergiesNotificationMessages
{
    EnergyAccumulatedFunc = energy => new NotificationMessage
    {
        Title = "Energy available!",
        Body = $"You have new '{energy.Id}' available!"
    },
    EnergyMaxFunc = energy => new NotificationMessage
    {
        Title = "Energy is full!",
        Body = $"'{energy.Id}' is full, spend it now!"
    },
    EnergyRewardAccumulatedFunc = energy => new NotificationMessage
    {
        Title = "Reward Energy available!",
        Body = $"You have new '{energy.Id}' available!"
    },
    EnergyRewardMaxFunc = energy => new NotificationMessage
    {
        Title = "Reward Energy is full!",
        Body = $"'{energy.Id}' is full, claim your reward!"
    }
};
unityMobileNotificationsSystem.ObserveSystem(energiesSystem, messages);

Manual scheduling #

To manually schedule a notification with custom properties, use ScheduleNotification.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
var title = "Notification Title";
var body = "The description of the notification";
var scheduledDateTime = DateTime.Today.AddHours(1);

var identifier = unityMobileNotificationsSystem.ScheduleNotification(
    new Notification
    {
        Title = title,
        Text = body,
    },
    new NotificationDateTimeSchedule(scheduledDateTime));

To cancel a scheduled notification, use CancelNotification with the integer identifier returned by ScheduleNotification.

1
unityMobileNotificationsSystem.CancelNotification(identifier);

Heroic Cloud