Таблица лидеров

Обзор

info

Вы можете открыть таблицу лидеров или получить список игроков таблицы.

Для работы с таблицами лидеров используются методы:

• gp.leaderboard.open - открыть лидерборд
• gp.leaderboard.fetch - получить список игроков лидерборда

Открыть таблицу

Чтобы не реализовывать на своей стороне отображение таблицы рекордов, её можно просто открыть во внутриигровом оверлее:

gp.leaderboard.open();

По умолчанию выводится топ, отсортированный по очкам игрока, но все поля можно кастомизировать:

gp.leaderboard.open({
    // Сортировка по полям слева направо
    orderBy: ['level', 'gold'],
    // Сортировка DESC — сначала большие значение, ASC — сначала маленькие
    order: 'DESC',
    // Количество игроков в списке
    limit: 10,
    // Включить список полей для отображения в таблице, помимо orderBy
    includeFields: ['rank'],
    // Вывести только нужные поля по очереди
    displayFields: ['rank', 'level'],
    /**
    * Показывать ли текущего игрока в списке, если он не попал в топ
    * none — не показывать
    * first — показать первым
    * last — показать последним
    */
    withMe: 'first'
});

События оверлея лидербордов

// При открытии
gp.leaderboard.on('open', () => {});

// При закрытии
gp.leaderboard.on('close', () => {});

Получить таблицу

Если есть потребность отрисовывать список самому, то можно просто получить список игроков:

const result = await gp.leaderboard.fetch({
    // Сортировка по полям слева направо
    orderBy: ['level', 'gold'],
    // Сортировка DESC — сначала большие значение, ASC — сначала маленькие
    order: 'DESC',
    // Количество игроков в списке
    limit: 10,
    // Включить список полей для отображения в таблице, помимо orderBy
    includeFields: ['rank'],
    /**
    * Показывать ли текущего игрока в списке, если он не попал в топ
    * none — не показывать
    * first — показать первым
    * last — показать последним
    */
    withMe: 'first'
});

// Результат получения
const { leaderboard, players, fields } = result;

Подключение Яндекс лидерборда

Для работы с таблицами лидеров Яндекс Игр создайте в консоли разработчика лидерборд с техническим названием score. Для этого:

• перейдите в приложения консоли Яндекс Игр
• выберите необходимую игру из списка
• откройте вкладку Лидерборды
• создайте лидерборд с техническим названием 💡 score
• сохраните таблицу

tip

score - это название, которые вы будете использовать для взаимодействия в SDK. При сохранении игрока (см. метод sync) значение переменной score автоматически сохраняется в лидерборд Яндекса.

info

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

Оставайтесь на связи

С другими разделами документации вы можете ознакомиться здесь. Для начала работы вы можете ознакомиться с нашими туториалами.

Сообщество GamePush в Telegram: @gs_community.

Для ваших обращений e-mail: [email protected]

Желаем вам успехов!