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













.








.

Account HUD

UI to open login flow

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 offer the player a button to manage their account.

πŸ“˜

Related Guides

A common use case for the feature is covered in the guides. It can be used to toggle the user-facing visibility of the Login Flow for a polished user experience. See Using Login Flow for more info.

The User Interface

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

The Beamable "Account HUD" 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 "Account 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 "Account HUD" in the Beamable Toolbox Window

🚧

Gotchas

Here are hints to help explain some of the trickier concepts.

  • The display text of some user-facing Beamable UI, including the word "Account" in the "Account HUD" is not customizable.

Updated 25 days ago


Account HUD


UI to open login flow

Suggested Edits are limited on API Reference Pages

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