icon

Остальное

Данный раздел — это сборник документации к модулям с небольшим содержанием документации.

- Префабы необходимо помещать в Canvas.
- При использовании префабов PluginYG рекомендуется создавть свой префаб вариант для избежания проблем при обновлении плагина.
Что такое префаб вариант?

Серверное время (ServerTime)

С помощью серверного времени вы можете сделать ежедневную награду за посещение игры, или что то похожее.
Метод YG2.ServerTime() возвращает значение типа long серверного времени в миллисекундах.
В Unity Editor значение серверного времени будет получено из соответ Server Time в настройках модуля.

Баннерная реклама (StickyAdv)

Необязательно импортировать модуль Sticky Adv, чтобы работала баннерная реклама. Модуль предназначен лишь для того, чтобы выключать и включать рекламу при необходимости. Для этого используйте метод:
YG2.StickyAdActivity(bool activity)

Полный экран (Fullscreen)

С помощью модуля Fullscreen вы можете развернуть игру на полный экран через код игры. В таком случае скроется баннерная реклама. Для этого используйте метод:
YG2.SetFullscreen(bool fullscreen)
Также есть поле isFullscreen — выполняет запрос к платформе о состоянии полного экрана и возвращает переменную bolean типа.

Ярлык на рабочий стол (GameLabel)

С помощью диалогового окна вы можете предложить пользователю добавить на рабочий стол ярлык — это может быть как ссылка на игру, так и ярлык Яндекс Игр — зависит от разных обстоятельств.

В папке модуля → Prefabs есть префаб Game Label со скриптом Game Label YG — это готовая кнопка для вызова диалогового окна установки ярлыка. Она будет деактивирована, если ярлык не доуступен. Отредактируйте объекты префаба по предпочтениям.

Вы можете создать свою реализацию с помощью следующий объектов:

  1. Метод YG2.GameLabelShowDialog — вызывает диалоговое окно, в котором будет предложено установить ярлык. Доступность опции зависит от платформы, внутренних правил браузера и ограничений платформы.
  2. Поле YG2.gameLabelCanShow — используется для определения доступности установки ярлыка.
  3. Событие YG2.onGameLabelSuccess — вызывается при успешной установки ярлыка. В этом случае можно выдать вознаграждение.
  4. Событие YG2.onGameLabelFail — вызывается при не успешной установке ярлыка.

Оценка игры (Review)

Вы можете попросить пользователя оценить игру и написать комментарий во всплывающем окне (появится в момент запроса оценки, закрывая фон приложения). Всплывающее окно не будет показано, если пользователь не авторизован или оценивал игру ранее.

Чтобы вызвать окно для оценки игры используйте метод YG2.ReviewShow(). Он откроет окно для оценки игры, если такая опция доступна.
Есть поле YG2.reviewCanShow — доступность отзыва.

В папке модуля → Prefabs есть префаб Review со скриптом Review YG — это готовая кнопка отзыва. Она будет деактивирована, если отзыв не доуступен.

Скрипт имеет четыре события:

  1. Review Available — выполните действие, которое должно произойти, если отзыв доступен.
  2. Review Not Available — выполните действие, которое должно произойти, если отзыв не доступен (если reviewCanShow = false). Действие может быть, например, скрыть кнопку.
  3. Review Success — выполните действие, которое должно происходить в случае, когда пользователь оставил отзыв. За это можно выдавать награду. На данный ивент так же можно подписаться в коде. Событие YG2.onReviewSent возвращает значения bool типа, которое равно true, если отзыв был успешно оставлен.
  4. Review Failed — выполните действие, которое должно происходить в случае, если пользователь не оставил отзыв, а закрыл окно для оценки игры.

Аналогичными событиями можно пользоваться в коде.

Буфер обмена (Clipboard)

В WebGL есть сложности с чтением и записью буфера обмена (CTRL + C, CTRL + V) из-за соображениям безопасности. Яндекс предоставляет только метод для записи:
YG2.SetClipboardText(string value)
Метод для чтения YG2.GetClipboardTextAsync(string value) — работает на других платформах. Необходимо передать колбек, который выполнится асинхронно.

Событие при выходе из игры (Quit Game Event)

Модуль Quit Game Event позволяет выполнить какой-либо метод при закрытии страницы игры (при выключении игры на WebGL).
При закрытии страницы выполнится поиск объекта на сцене с определённым названием, и в этом объекте произведётся поиск метода по названию в скриптах объекта.
В настройках плагина необходимо указать название объекта и название метода.
• Объект должен быть без родителей, то есть объект не должен учавствовать в какой-либо иерархии объектов.
• Метод не должен принимать как-либо значений.