|
1 | | -# Beam Library overview |
| 1 | +# Beam Samples overview |
2 | 2 |
|
3 | | -The Beam Library is a collection of package samples and prefabs to help get you started learning the Unity SDK. To open the Beam Library, click on the Beamable Button (at the top-right of the Unity window), and select _Beam Library_. |
| 3 | +The **Beam Samples** window is a collection of Lightbeam samples that help you get started learning the Unity SDK. To open it, click the Beamable button (at the top-right of the Unity window) and select _Beam Samples_. |
4 | 4 |
|
5 | | -{width="400px"} |
| 5 | +{width="400px"} |
6 | 6 |
|
7 | | -Now the _Beam Library_ should be open. |
| 7 | +Now the _Beam Samples_ window should be open. |
8 | 8 |
|
9 | | -{width="400px"} |
| 9 | +{width="400px"} |
10 | 10 |
|
11 | | -Each card represents a Package Sample. When you click the "Open Scene" button, a Beamable sample will be added to your assets folder under `Assets/Samples/Beamable`. |
| 11 | +Each card represents a Lightbeam sample. Selecting a sample copies it into your project under `Assets/Samples/Beamable`. |
12 | 12 |
|
13 | 13 | ## Admin Console |
14 | 14 |
|
15 | | -Most of the package samples are entire Scenes that help you get started understanding a topic. However, the _Admin Console_ is unique, because it is a prefab that gets added to your project.The prefab is helpful to dropping into your project, because you can use it to interact with Beamable at runtime. |
| 15 | +!!! warning "Deprecated: prefab-based Admin Console" |
| 16 | + Earlier SDK versions shipped the Admin Console as a prefab (the "Admin Flow" feature) that you added to your scene from this window. That prefab is deprecated and scheduled for removal in a future release. The Admin Console is now a built-in runtime integration that requires no prefab — see [Admin console](../runtime-systems/admin-console.md) for setup, the built-in command reference, and the custom-command API. |
16 | 17 |
|
17 | | - |
18 | | -### Admin Console prefab |
19 | | - |
20 | | -#### Overview |
21 | | - |
22 | | -The **Admin Flow** Feature Prefab provides developers with debugging capabilities. |
23 | | - |
24 | | -The purpose of this feature is to offer the game maker an in-game UI for executing game commands and cheats. |
25 | | - |
26 | | -#### Usage |
27 | | - |
28 | | -The Admin Flow can be opened at runtime in multiple ways: |
29 | | - |
30 | | -- Within the Unity Editor, press the "~" key |
31 | | -- Within a Mobile Build, use a "three-finger swipe-up gesture" |
32 | | - |
33 | | -#### The user interface |
34 | | - |
35 | | -{width="200px"} |
36 | | - |
37 | | -#### Adding to your project |
38 | | - |
39 | | -The Admin Prefab is accessible via the _Beam Library_ window. You can open the _Beam Library_ and add the admin prefab to your scene. |
40 | | - |
41 | | -#### Admin commands |
42 | | - |
43 | | -Once the Admin Flow is open, type an admin command into the input field and press return. |
44 | | - |
45 | | -There are built-in Beamable admin commands and game makers can create custom admin commands for additional functionality. |
46 | | - |
47 | | -##### Using Beamable admin commands |
48 | | - |
49 | | -| Command | Detail | |
50 | | -| :---------------------------------------------- | :------------------------------------------------------------------------------------------------------------------- | |
51 | | -| `help` | Shows the list of all admin commands | |
52 | | -| `TRACK_PAYMENT` | Track a test payment audit | |
53 | | -| `ECHO <message>` | Repeat message to console. | |
54 | | -| `WHERE <command>` | Find where a specific console command was registered from, if it was registered with a DBeamConsoleCommand attribute | |
55 | | -| `account_toggle` | emit an account management toggle event | |
56 | | -| `account_list` | list user data | |
57 | | -| `IDFA` | print advertising identifier | |
58 | | -| `RESET` | Clear the access token and start with a fresh account | |
59 | | -| `LOCALNOTE [<delay> [<title> [<body>]]]` | Send a local notification. Default delay is 10 seconds. | |
60 | | -| `TIMESCALE <value> \| variable` | Sets the current timescale | |
61 | | -| `SUBSCRIBER_DETAILS` | Query subscriber details | |
62 | | -| `DBID` | Show current player PlayerId | |
63 | | -| `ENTITLEMENTS <symbol> <state>` | Show current player entitlements | |
64 | | -| `HEARTBEAT <dbid>` | Get heartbeat of a user | |
65 | | -| `LOGIN_ACCOUNT <email> <password> ` | Log in to the PlayerId designated by the given username and password | |
66 | | -| `MAIL_GET <category>` | Get mailbox messages | |
67 | | -| `MAIL_UODATE <id> <state> <acceptAttachments> ` | Update a mail | |
68 | | -| `REGISTER_ACCOUNT <email> <password>` | Registers this PlayerId with the given username and password | |
69 | | -| `EXPIRE_TOKEN` | Expires the current access token to trigger the refresh flow | |
70 | | -| `CORRUPT_TOKEN` | Corrupts the current access token to trigger the refresh flow | |
71 | | -| `TEST-ANALYTICS` | Run 1000 events to test batching/load | |
72 | | -| `IAP_BUY <listing> <sku>` | Invokes the real money transaction flow to purchase the given item_symbol. | |
73 | | -| `IAP_PENDING` | Displays pending transactions | |
74 | | - |
75 | | -#### Force-enabled |
76 | | - |
77 | | -Within the Unity Editor, press the "~" key to open the in-game console. This always works, regardless of player privileges or "Admin Flow" settings. |
78 | | - |
79 | | -On device, use a three-finger swipe gesture to open the in-game console. This only works if the player has sufficient privileges, or if the "Admin Flow" settings specify the console should always be available. |
80 | | - |
81 | | -!!! info "Best Practice" |
82 | | - |
83 | | - - For security reasons, it is not recommended to allow a players to access the in-game console. Beamable has precautions in place to prevent this |
84 | | - |
85 | | -The in-game console, on-device, will **only** appear if the force-enabled checkbox is true, or if the current player's account has tester, developer, or admin privileges. |
86 | | - |
87 | | -The Beamable Portal allows game makers to grant player privileges. This privilege-requirement only applies to device, not the Unity Editor. |
88 | | - |
89 | | - |
90 | | -### AdminFlow API |
91 | | - |
92 | | -#### Creating custom admin commands |
93 | | - |
94 | | -Game makers can create custom admin commands for additional functionality. |
95 | | - |
96 | | -AdminFlowCustomCommandExample.cs |
97 | | -```csharp |
98 | | -using Beamable.ConsoleCommands; |
99 | | -using UnityEngine; |
100 | | - |
101 | | -namespace Beamable.Examples.Features.AdminFlow |
102 | | -{ |
103 | | - [BeamableConsoleCommandProvider] |
104 | | - public class CustomConsoleCommandProvider |
105 | | - { |
106 | | - [BeamableConsoleCommand ("Add", "A sample addition command", "Add <int> <int>")] |
107 | | - public string Add(string[] args) |
108 | | - { |
109 | | - var a = int.Parse(args[0]); |
110 | | - var b = int.Parse(args[1]); |
111 | | - return "Result: " + (a + b); |
112 | | - } |
113 | | - } |
114 | | - |
115 | | - /// <summary> |
116 | | - /// Demonstrates <see cref="AdminFlow"/>. |
117 | | - /// </summary> |
118 | | - public class AdminFlowCustomCommandExample : MonoBehaviour |
119 | | - { |
120 | | - // Unity Methods -------------------------------- |
121 | | - protected void Start() |
122 | | - { |
123 | | - Debug.Log($"Start() Instructions...\n" + |
124 | | - " * Run The Scene\n" + |
125 | | - " * Type '~' in Unity Game Window to open Admin Console\n" + |
126 | | - " * Type 'Add 5 10'\n" + |
127 | | - " * See 'Result: 15' in Unity Console Window\n"); |
128 | | - } |
129 | | - } |
130 | | -} |
131 | | -``` |
0 commit comments