Beamable Documentation

Welcome! Here is everything you need to get setup and become a Beamable expert.

Begin with the Getting Started section, learn more about Beamable features in the Manual, and check out the Script Reference APIs for advanced workflows.

Choose from the following...













.








.

Leaderboard Flow

Allow player to manage leaderboard

Overview

This page includes everything needed to use this feature in the "Beamable SDK for Unity". Or watch this 5 minute video.

The purpose of this feature is to allow the player to see the LeaderboardLeaderboard - A list of high scores by all players of a game.

The User Interface

When setup properly, the player's user interface in the game project will be as follows.

The Beamable "Leaderboard Flow" UI in the Unity Game Window

Steps

Follow these steps to get started.

Step

Detail

  1. Open the "Toolbox" Window

• Unity → Window → Beamable → Open Beamable Toolbox

  1. Add the "Leaderboard Flow" Prefab

• Drag this Prefab from the Beamable Toolbox Window to the Unity Hierarchy Window

Here is the "Beamable" menu as seen in Unity.

The “Beamable” Menu

Here is the feature Prefab as seen in the Beamable Toolbox.

The Beamable "Leaderboard Flow" in the Beamable Toolbox Window

Advanced

Here are a few advanced configuration options and workflows.

Creating Leaderboard Content

LeaderboardLeaderboard - A list of high scores by all players of a game content is required to properly populate the Leaderboard UI.

Step

Detail

  1. Open the Content Manager Window

• Unity → Window → Beamable → Open Content Manager

  1. Expand the "Leaderboards" Section

• Click the :arrow-down: button

  1. Add the "Leaderboard"
• Click the :heavy-plus-sign: button • Populate the name
  1. Open the Unity Project Window

• Unity → Window → General→ Project

  1. Select the leaderboard asset

• Search by the name given in step #3
• View the asset in the Unity Inspector Window

  1. (Optional) Configure data fields

Note: The Write_self variable allows for client-authoritative score updates. Ex. For a simple single-player game with leaderboards as a social feature, this must be set to true. For higher security against hackers, set to false.

  1. Save the Unity Project

• Unity → File → Save Project

Best Practice: If you are working on a team, commit to version control in this step.

  1. Publish the content

• Press the "Publish" button in the Content Manager Window

Rewarding Leaderboard-Related Score

To appear on the Leaderboard, a player must have a competitive score.

During Development

The Portal allows the game maker to view and edit a player's score. This is a helpful, temporary workflow during the design and development of a new game feature.

During Production

To properly reward the players with score in production code, use custom C#. See the following example for inspiration.

namespace DisruptorBeam.Examples.Features.LeaderboardFlow
{
   public class LeaderboardSetScoreExample : MonoBehaviour
   {
      public double Score;
      public LeaderboardRef Leaderboard;

      protected async void Start()
      {
         LeaderboardSetScore(Leaderboard.Id, Score);
      }

      private async void LeaderboardSetScore(string id, double score)
      {
         var de = await DisruptorBeam.DisruptorEngine.Instance;
         await de.LeaderboardService.SetScore(id, score);
      }
   }
}

📘

FAQ

Here are highlights from the Beamable FAQ. See FAQ for more info.

Leaderboard Flow

Updated 15 days ago


Leaderboard Flow


Allow player to manage leaderboard

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.