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













.








.

Step 2 - Using Login Flow

Overview

The purpose of this guide is for game makers to use the Beamable Login Flow.

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

User Experience

When setup properly, the user experience in the game project will be as follows.

Steps

Follow these steps to get started.

Step

Detail

  1. Open the "Toolbox" Window

• Unity → Window → Beamable → Open Toolbox

  1. Add the "Account HUD" Prefab

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

  1. Add the "Login Flow" Prefab

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

Result: The Unity Hierarchy Window contains both prefabs.

  1. (Optional) Disable the "Account HUD" Prefab

• Select this Prefab in the Unity Hierarchy Window
• View this Prefab in the Unity Inspector Window.
• Uncheck the "Enabled" Checkbox.

Result: Now this UI will not be initially visible to player at runtime

  1. (Optional) Enable the "Account HUD" Prefab

• Select the "Account HUD" Prefab in the Unity Hierarchy Window
• View this in the Unity Inspector Window
• Find the "Account Management Signals" Component
• Find the "On Toggle Account Management" Event Component
• Click the "+" Button
• Drag the "Account HUD" Prefab from the Unity Hierarchy Window into the Object field next to the "+" Button
• Select "GameObject.SetActive" from the dropdown

Result: Now this UI will be visible to player at runtime after the Beamable system is ready

User Interface

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

The Beamable "Login" UI in the Unity Game Window

From here, the player can edit account details including account name and account avatar.

The player can switch accounts and sign in with various methods. See the Login Flow feature page for more info.

When finished, the player can close the Login Flow window and return to the game-specific content.

Updated about a month ago



Step 2 - Using 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.