Breakroom Teleport Portal

Whether you want to highlight a region as a must-see, limit the number of regions users can visit, or make it easier for virtual explorers to get around—the Breakroom Teleport Portal is a key tool.


The Breakroom Teleport Portal allows users to fast-travel between different regions in your Breakroom World. You can use these portals to:

  • Call user attention to must-see regions and activities

  • Present users with a limited number of regions to visit (when you have otherwise disabled open exploration by removing access to the Explore window)

  • Make it easier for users to navigate multi-region events

For help installing the Breakroom Teleport Portal, please see our Region Editor documentation.

Breakroom Teleport Portal user controls

Users can activate any Breakroom Teleport Portal by walking "into" it. When a portal is activated, a pop-up will appear containing a list of accessible regions, complete with splash images and customized text.

Users can click on the labeled destination tiles to learn more about each region. To travel to the region currently highlighted in the main window, users can click the Teleport button.

To dismiss the Breakroom Teleport Portal pop-up, users can click the Cancel button or walk away from the portal.

Setting up the Breakroom Teleport Portal

The Breakroom Teleport Portal control panel is only visible to the object Owner and staff with the appropriate permissions. To access it, click on the teleport portal object.

Users can access up to four different destinations through a single teleport portal. To add a new destination to a portal, follow these steps:

  1. Locate the Breakroom Teleport Portal object you want to edit, and click on it to launch the control panel.

  2. In the control panel, you'll see four region destination tabs (labeled Region 1 through Region 4). Click on the region tab you want to edit, if it is not already expanded.

  3. First, select a splash image for your destination.

    1. To choose an image you've already uploaded to Breakroom, click the Image Library button. This will open the image picker. Click on the image you want to use.

    2. To upload a new splash image from your computer, or click the Upload New Image button. This will open a standard file picker on your computer. Locate the image you want to use, click on it, and then click the Open button.

  4. Next, enter a description or call to action in the Region Description field. This description will be superimposed on your chosen splash image, so you may want to keep it on the shorter side.

  5. Enter a name for the region in the Region Name field.

  6. To ensure users travel to the correct place, you will need to enter the destination region ID. This can be found on your Breakroom Dashboard.

    1. On your Dashboard, navigate to World Customization > Regions.

    2. Locate the region destination you want to use. Click the Copy button located in the bottom left corner of the region tile to copy the displayed region ID.

    3. Paste the region ID into the Region ID field in the Breakroom Teleport Portal control panel.

  1. Finally, toggle the Region Active button to On.

  2. Click the Save and Close button.

The Splash Image, Region Description, and Region Name fields are all optional. However, customizing these fields greatly increases the usability of the teleport portal and offers an superior experience.

You can toggle the Region Active button to Off to disable a teleport destination while retaining its data.

Editing the Breakroom Teleport Portal collider zone

The Breakroom Teleport Portal is activated when users enter its collider zone. The size and position of this collider zone can be customized using the Region Editor.

The instructions provided below presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help installing and positioning virtual objects, or editing the RoomFurniture component.

To edit the Breakroom Teleport Portal collider zone, follow these steps:

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. Locate the Breakroom Info Kiosk object you want to edit. Click on it to highlight it in the Objects window.

  3. In the Objects window, click the > arrow to the left of the Breakroom Teleport Portal object to expand it. Then click on the Collider component.

  4. Using the Region Editor tools or the Transform component, move, rotate, and resize the collider to meet your specifications.

  5. When you are satisfied, click the Save button to store your changes.

Last updated

©2008-2024 Sine Wave Entertainment Ltd. All Rights Reserved.