1 of 3

Inventory

Integration Guide

Unity

Unity integration

Introduction

After the user purchases a Virtual Item, it is automatically added to the user's Inventory during the transaction process. It is possible also to add a virtual item to the user's inventory without going through the purchase process for non-NFT items.

InventoryItem

id (string): Unique inventory id for this item.
virtualItemId (string): Id of the virtual item stored in the inventory.
quantity (int): Amount of items store in this inventory slot.
appIds (List<string>): List of project id where this item will be accessible.
tags (List<string>): List of tags used for filtering items.
properties (List<Property>): List of properties for this inventory item.

Retrieving inventory items with Virtual Items data

The following method gets all inventory items for the currently logged in player.

Add to inventory

Add to inventory can be use to add regular virtual items into the player inventory. NFT's cannot be added to the inventory with this function.

Set Properties

Get properties

Unreal

Unreal integration

Introduction

InventoryItem

id (string): Unique inventory id for this item.
virtualItemId (string): Id of the virtual item stored in the inventory.
quantity (int): Amount of items store in this inventory slot.
appIds (List<string>): List of project id where this item will be accessible.
tags (List<string>): List of tags used for filtering items.
properties (List<Property>): List of properties for this inventory item.

Get inventory items

Add to inventory

Add to inventory can be use to add regular virtual items into the player inventory. NFT's cannot be added to the inventory with this functionality.

Get inventory item properties

Set inventory item properties

Unreal

Unreal integration

Introduction

InventoryItem

id (string): Unique inventory id for this item.
virtualItemId (string): Id of the virtual item stored in the inventory.
quantity (int): Amount of items store in this inventory slot.
appIds (List<string>): List of project id where this item will be accessible.
tags (List<string>): List of tags used for filtering items.
properties (List<Property>): List of properties for this inventory item.

Get inventory items

Add to inventory

Add to inventory can be use to add regular virtual items into the player inventory. NFT's cannot be added to the inventory with this functionality.

Add to inventory posted by Car3manPLAY | blueprintUE | PasteBin For Unreal Engineblueprintue

Get inventory item properties

Get Inventory Item Properties posted by Car3manPLAY | blueprintUE | PasteBin For Unreal Engineblueprintue

Set inventory item properties

Set Inventory Item Properties posted by Car3manPLAY | blueprintUE | PasteBin For Unreal Engineblueprintue

Unity

Unity integration

Introduction

InventoryItem

id (string): Unique inventory id for this item.
virtualItemId (string): Id of the virtual item stored in the inventory.
quantity (int): Amount of items store in this inventory slot.
appIds (List<string>): List of project id where this item will be accessible.
tags (List<string>): List of tags used for filtering items.
properties (List<Property>): List of properties for this inventory item.

Retrieving inventory items with Virtual Items data

The following method gets all inventory items for the currently logged in player.

Add to inventory

Add to inventory can be use to add regular virtual items into the player inventory. NFT's cannot be added to the inventory with this function.

using UnityEngine;
using RGN.Modules.Inventory;

public class InventoryExamples : MonoBehaviour
{
    private async void AddToUserInventory()
    {
        string virtualItemId = "virtualItemToAdd";
        await InventoryModule.I.AddToInventoryAsync(virtualItemId);
    }
}

Set Properties

using UnityEngine;
using RGN.Modules.Inventory;

public struct MyCustomProperties
{
    public int BonusHealth;
    public float DamageMultiplier;
}

public class InventoryExamples : MonoBehaviour
{
    private async void SetPropertiesInInventory()
    {
        string inventoryItemId = "inventoryItemId";

        MyCustomProperties customProperties = new MyCustomProperties
        {
            BonusHealth = 50,
            DamageMultiplier = 1.5f
        };
        string jsonProperties = JsonUtility.ToJson(customProperties);

        await InventoryModule.I.SetPropertiesAsync(inventoryItemId, jsonProperties);
    }
}

Get properties

using UnityEngine;
using RGN.Modules.Inventory;

public struct MyCustomProperties
{
    public int BonusHealth;
    public float DamageMultiplier;
}

public class InventoryExamples : MonoBehaviour
{
    private async void GetPropertiesInInventory()
    {
        string inventoryItemId = "inventoryItemId";
        string jsonProperties = await InventoryModule.I.GetPropertiesAsync(inventoryItemId);
        MyCustomProperties customProperties = JsonUtility.FromJson<MyCustomProperties>(jsonProperties);
        Debug.Log($"Bonus health : {customProperties.BonusHealth} \n" +
            $"Damage multiplier : {customProperties.DamageMultiplier}");
    }
}

using UnityEngine;
using RGN.Modules.Inventory;

public struct MyCustomProperties
{
    public int BonusHealth;
    public float DamageMultiplier;
}

public class InventoryExamples : MonoBehaviour
{
    private async void SetPropertiesInInventory()
    {
        string inventoryItemId = "inventoryItemId";

        MyCustomProperties customProperties = new MyCustomProperties
        {
            BonusHealth = 50,
            DamageMultiplier = 1.5f
        };
        string jsonProperties = JsonUtility.ToJson(customProperties);

        await InventoryModule.I.SetPropertiesAsync(inventoryItemId, jsonProperties);
    }
}

using UnityEngine;
using RGN.Modules.Inventory;

public struct MyCustomProperties
{
    public int BonusHealth;
    public float DamageMultiplier;
}

public class InventoryExamples : MonoBehaviour
{
    private async void GetPropertiesInInventory()
    {
        string inventoryItemId = "inventoryItemId";
        string jsonProperties = await InventoryModule.I.GetPropertiesAsync(inventoryItemId);
        MyCustomProperties customProperties = JsonUtility.FromJson<MyCustomProperties>(jsonProperties);
        Debug.Log($"Bonus health : {customProperties.BonusHealth} \n" +
            $"Damage multiplier : {customProperties.DamageMultiplier}");
    }
}