Using Hyperspace Variables

Using Hyperspace Variables

Add variables to personalize the experience for players. These variables can be used in notes, notifications, chat, urls, and anywhere that text is displayed.

Important note: Once configured in an item, re-editing the item will replace the variables with your details. If you need to edit an item with variables, you will need to type in the variables again replacing the rendered values.

Example:

“This is your firstName: %%firstName%%” in a note’s innerHTML field will resolve to
“This is your firstName: John” when the space is loaded. If this note is edited without placing the variable again, it will be stuck on the revolved value (i.e. “John”).

Demo space: https://app.learnbrite.com/dashboard/worlds/wrle7e2835aacaf8f84760015 

Use in notes

Use in notifications

Use in chat

Use in URLs

Supported Hyperspace variables

%%email%%

%%encodedEmail%%

%%fullName%%

%%encodedFullName%%

%%firstName%%

%%lastName%%

%%spaceName%%

%%spaceDesc%%

Use in notes

Place the variable into the innerHTML field.


Use in notifications

When using the displayNotification action in the on click field, place the variable in the “message” parameter.


{"action":"displayNotification", "message":"Hi %%firstName%%!"}

When using in the Conversation/Action Editor, place the variable in the “text” parameter.

Use in chat

Place the variables within the text of your chat message.

Use in URLs

Using the action “openURLinNewWindow” within the On Click field of a Mediaboard, append the URL with a parameter to pass information using a “?”. Place the variable after the “=” in the parameter.

Similarly, using the action “displayMediaboard” within the On Click field of a Mediaboard, append the URL with a parameter to pass information using a “?”. Place the variable after the “=” in the parameter.

Supported Hyperspace variables

%%email%%

For guest users the email will not be a valid email address, instead it contains a unique guest ID eg. guest60fd87bb0393c2ac8e5

%%encodedEmail%%

URL encoded email address. Eg. danny%40mootup.com

%%fullName%%

Full name of the participant

%%encodedFullName%%

URL encoded full name of the participant

%%firstName%%

First name of the participant

%%lastName%%

Last name of the participant

%%spaceName%%

The name of the current space

%%spaceDesc%%

The description of the current space. May be empty.

How useful was this article?

Click on a star to rate it!

We are sorry that this article was not useful for you!

Let us improve this article!

Tell us how we can improve this article?