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













.








.

Login Flow

Allow user to manage account

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 manage their account.

πŸ“˜

Related Guides

A common use case for the feature is covered in the guides. Its user-facing visibility can be toggled by the Account HUD for a polished user experience. See Using Login Flow and Skinning 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 "Login Flow" 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 "Login 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 "Login Flow" in the Beamable Toolbox Window

Advanced

Here are a few advanced configuration options and workflows. The visual appearance of the UI is customizable. See Skinning for more info.

🚧

Gotchas

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

  • The display text of "Account" in the UI is not customizable.

Updated 6 days ago


Login Flow


Allow user to manage account

Suggested Edits are limited on API Reference Pages

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