VRRSS vrenaissance

VRRSS // DEVELOPER DOCUMENTATION

API, Unity SDK и интеграция проверки лицензий

VRHub #

Основной класс API для VRenaissance Hub.

Определение #

Пространство имен: VRRSS.SDK.HubAPI
Тип: Статический класс
Наследование: -

Реализует API для VRenaissance Hub.

public static class VRHub

События #

LicenseVerificationCompleted #

Тип: LicenseEventHandler
Описание: Срабатывает при получении обратного вызова от плагина после завершения проверки лицензии. Передает результаты проверки как LicenseStatus. Срабатывает каждые 5 минут после инициализации в плагине. Для инициализации следует использовать InitializeGameWithLicense.

public static event LicenseEventHandler LicenseVerificationCompleted;

Note

Вызов данного события обычно происходит не в основном потоке выполнения Unity. При работе с этим событием вы можете столкнуться с ошибкой типа ...can only be called from the main thread. Это обычно происходит при работе с компонентами Unity API. В таких случаях следует использовать Dispatcher.


Методы #

SendCommand #

Описание: Отправляет пользовательскую команду для VRenaissance Hub.

public static void SendCommand(string command)

Параметры #

command #

Тип: string
Описание: Команда.

Пример использования #

SendCommand("window?command=maximize");

InitializeGame #

Описание: Инициализирует игру в VRenaissance Hub по ее идентификатору.

public static bool InitializeGame(string gameId)

Параметры #

gameId #

Тип: string
Описание: Идентификатор игры.

Результат #

Тип: bool
Описание: Успешность инициализации игры.

Пример использования #

bool isGameInitialized = InitializeGame("com.stvdev.netoa");

InitializeGameWithLicense #

Описание: Инициализирует игру в VRenaissance Hub по ее идентификатору и запускает цикл проверки лицензии. Проверка лицензии будет выполняться каждые 5 минут до завершения игрового процесса. Для обработки результатов проверки следует использовать LicenseVerificationCompleted.

public static void InitializeGameWithLicense(string gameId)

Параметры #

gameId #

Тип: string
Описание: Идентификатор игры.

Пример использования #

InitializeGameWithLicense("com.stvdev.netoa");

StopLicenseVerification #

Описание: Останавливает цикл проверки лицензии, если он запущен. После остановки LicenseVerificationCompleted будет вызван со статусом LicenseStatus.Canceled.

public static void StopLicenseVerification()

Пример использования #

StopLicenseVerification()

ShowMessage #

Описание: Отображает диалоговое окно с сообщением в VRenaissance Hub.

public static void ShowMessage(string body, string header = "", MessageType type = MessageType.None)

Параметры #

body #

Тип: string
Описание: Текст сообщения.

Тип: string
Описание: Заголовок сообщения.
По умолчанию: ""

type #

Тип: MessageType Описание: Тип сообщения.
По умолчанию: MessageType.None

Пример использования #

ShowMessage("Something went wrong.", "Oops...", MessageType.Error);