Настраиваемые функции

Что такое настраиваемые функции и зачем оно вообще.

Описание

Настраиваемые функции позволяют создавать дополнительные кнопки для меню игры в приложении управления. Каджая функция может иметь любое количество требуемых для вызова параметров. Для заполнения данных параметров у в приложении управления будут создаваться необходимые поля.

Поддерживаемые типы параметров

Декларация	Описание
String	Произвольная строка.
Integer	Целое число.
Number	Действительное число.
Bool	True/False.
BrainyUser	ID пользователя Brainy Universe (приложение пользователя). Прим.: В работе.
Color	Цвет в формате HEXA.
ColorRGB	Цвет в формате RGB.
ColorHSV	Цвет в формате HSV.
ColorHSV16	Цвет в формате HSV16.
[Value1,Value2,...]	Перечисление (ENUM), где Value1 и Value2 - варианты выбора.
Pin	Строка в формате пин-кода.
Password	Строка в формате пароля.
Email	Строка в формате адреса электронной почты.
Name	Строка в формате имени.

Формат декларации

Набор функций, доступных в игре, декларируется в поле CustomFunctions контейнера UVRController в HEARTBEAT сообщении. Декларация представляет собой словарь, для которого:

Ключ: Произвольная уникальная строка, обозначающая название функции. Значение: Набор параметров функции в формате словаря, для которого:

Ключ: Произвольная уникальная строка, обозначающая название параметра. Значение: Строка, обозначающая тип параметра.

C# Декларация

/// <summary>
/// Custom controller functions (Name, (Argument Name, Argument type)).
/// </summary>
public Dictionary<string, Dictionary<string, string>> CustomFunctions { get; } = new Dictionary<string, Dictionary<string, string>>();

Json Пример

"CustomFunctions": {
    "Сообщение Игрокам": {
      "Сообщение": "string",
      "Время": "integer"
    },
    "Перезагрузить сервер": {}
  }

Формат вызова

Запрос на вызов функции передаётся от приложения управления к игре в FUNCTION сообщении. Вызов функции представляется в виде кортежа, для которого:

Значение 1: Название вызываемой функции. Значение 2: Значение требуемых параметров в формате словаря, для которого:

Ключ: Название параметра. Значение: Значение параметра.

Значения всех параметров передаются как строка.

Json Пример

{
    "Item1": "Сообщение Игрокам",
    "Item2": {
        "Сообщение": "Матч остановлен!",
        "Время": "120"
    }
}

Системные функции

Формат вызова функции в FUNCTION сообщении используется так же для передачи данных от остального функционала приложения управления (например настройка имени шлема или запрос на смену режима). Название системных функций начинается с символа #. На данный момент имеются следующие системные функции:

#SetHelmetInfo

Описание

Запрос на обновление информации о шлеме в игре.

Параметры

Название	Тип	Описание
#HelmetID	String	Id шлема, для которого запрошена установка информации.
#HelmetName	String	Новое имя шлема.
#HelmetBrainyUse	Integer	Новый ID пользователя Brainy Universe, привязанного к этому шлему.

---

#SetGameMode

Описание

Запрос на смену игрового режима.

Параметры

Название	Тип	Описание
#Mode	String	Название выбранного режима.
#Map	String	Название выбранной карты.

Так же для этой функции в качестве параметров будут передаваться все параметры, запрашиваемые выбранным режимом.