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













.








.

Announcements Flow

Allow player to manage announcements

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 AnnouncementAnnouncement - A message sent by the game maker to all game playerss.

The User Interface

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

The Beamable "Announcements 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 "Announcements 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 "Announcements Flow" in the Beamable Toolbox Window

Creating An Announcement

Game makers can create custom announcements for distribution to players.

Step

Detail

  1. Open the Content Manager Window

• Unity → Window → Beamable → Open Content Manager

  1. Expand the "Announcements" Section

• Click the :arrow-down: button

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

• Unity → Window → General→ Project

  1. Select the announcement asset

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

  1. Populate all data fields
*Note: The date fields must be formatted like `2019-03-28T00:00:00Z`*
  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

📘

FAQ

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

Announcements Flow

Updated 15 days ago


Announcements Flow


Allow player to manage announcements

Suggested Edits are limited on API Reference Pages

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