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...













.








.

Currency HUD

UI for virtual currency

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 UI for their virtual currency.

πŸ“˜

Related Guides

A common use case for the feature is covered in the guides. See Adding Content for more info.

Why Use In-Game Currency?

What Can Players Use Currency For?

The usage of currencies depends on the game's design. Some currencies are used to mark or symbolize the player's progress through the game. The player 'feels' they have achieved more progress when they see the currency increase. Experience points (XP) is a good example of this.

A game also may allow the player to unlock content by spending currency.

Types of Currency

It is common to think about in-game currency in two major types; Hard CurrencyHard Currency - A currency type rewarded to the player through IAP transactions of real-world money. (Ex. Gems) and Soft CurrencySoft Currency - A currency type rewarded to the player through gameplay progression. (Ex. Experience Points or XP).

Many teams design a multiple currency model for their in-game economies.

NameDetail
Hard CurrencyRewarded to the player through IAP trasactions

Example: Gems
Soft CurrencyRewarded to the player through gameplay progression

Example: Experience Points (XP)

The User Interface

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

The Beamable "Currency HUD" UI in the Unity Game Window

Steps

Follow these steps to get started.

StepDetail
1. Open the "Toolbox" Windowβ€’ Unity β†’ Window β†’ Beamable β†’ Open Beamable Toolbox
2. Add the "Currency HUD" 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 "Currency HUD" in the Beamable Toolbox Window

Defaults

Some Beamable features include some setup and configuration by default.

Gems

Beamable includes Gems in the game project by default. Press the "-" button in the Content Manager to delete the Gems if Gems are not desired.

Advanced

Here are a few advanced configuration options and workflows.

Adding A New Custom Currency

Currency is optional in each game project. Beamable supports multiple currencies. See Step 4 - Adding Content for more info on adding a new custom currency.

Addressables Support For Currency

The currency system supports Unity's Addressables. See Step 4 - Adding Content for more info on adding a new custom currency.

Gifting Currency By DBID

The Portal allows the game maker to gift currency to a player.

  1. Open the Portal
  2. Search for player by DBIDDBID - The database identification. Beamable generates an anonymous account for the player when the project first runs or email
  3. Increment the amount, for existing currency type
  4. or add the currency, for a new currency type

Rewarding Currency To Player

There are several ways to reward currency to the player;

Updated 6 days ago


Currency HUD


UI for virtual currency

Suggested Edits are limited on API Reference Pages

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