LogoLogo
Tutorial VideosScripting DocumentationLegalHome
Breakroom
Breakroom
  • Welcome to Breakroom
  • GETTING STARTED
    • Helpful terms
    • UI tour
    • Keyboard shortcuts
    • Customizing your avatar
      • Choosing a starter avatar
      • Editing avatars in the Outfit window
      • Using the Sine Wave Shop
    • Controlling your avatar
    • Controlling your camera
    • Communicating with other users
    • Using the conference system
      • Troubleshooting audio and video issues
    • Using Breakroom for Training
    • Settings
    • Language and accessibility
    • Reporting issues
  • EXPLORING BREAKROOM
    • Region navigation tools
    • Bookmarks and teleport invites
    • Using the Explore window
    • Using the Meetings window
    • Networking with other users
      • People
      • Groups
    • Snapshots
  • BUILDING NEW WORLDS
    • Breakroom Dashboard tour
    • Creating and managing Regions
    • Default Landing and Orientation Regions
    • Region settings
    • Region template descriptions
  • CREATING CUSTOM EXPERIENCES
    • Branding tools
    • UI customization options
    • Filtering the Sine Wave Shop
    • Selecting default avatars
      • Default avatar collections
    • Using the Region Editor
      • Editing and moving objects
      • Editing terrain and sky
      • The Region Editor ADVANCED window
    • Exploring the Breakroom Toolkit
      • Breakroom Video Player
      • Breakroom Web Browser
      • Breakroom Image Viewer
      • Breakroom Info Kiosk
      • Breakroom Teleport Portal
      • Breakroom Web Collab
      • Breakroom Note Board
      • Breakroom Games
      • Breakroom Reactives
      • Breakroom Orientation Quest
      • Breakroom Tour Cameras
      • Conference rooms and booths
      • Add-on seats
      • Breakroom Start Here UI
      • Breakroom Basic Emojis
      • Breakroom 360° Video Player
    • Managing your Media Library
  • OPENING THE DOORS
    • Seats and concurrency
    • Creating and managing user accounts
      • World-level user permissions
      • Region-level user permissions
      • Single sign-on
      • Eventbrite integration
    • World Stream
      • Purchasing and managing World Credits
      • Pre-allocation campaigns
      • World Stream viewer toolbars
      • World Stream keyboard shortcuts
      • Troubleshooting World Stream issues on Chrome
      • Troubleshooting World Stream issues on macOS
    • Desktop viewers
    • Privacy Policies, EULAs, and data collection
    • Analytics
    • Toggling World availability
  • RUNNING YOUR EVENT
    • Understanding the conference system
      • Voice zones, zone types, and conference permissions
      • Voice chat and spatial audio
    • Customizing the conference system components
      • Adding breakout areas
      • Creating custom voice zones
      • Setting up Presenter and Audience zones
      • Designating triage zones
      • Troubleshooting duplicate zone errors
      • The RoomFurniture component
    • Setting up Breakroom for Training courses
    • Moderator tools
      • Broadcast messages
      • Crowd management
      • Audience questions
      • Raised hands
      • Presentation controls
      • Hidden UI toggle
      • Participation
      • Audio streams
  • TIPS FOR SUCCESS
    • Region Editor best practices
    • Onboarding new users
  • ADVANCED TUTORIALS
    • Uploading your own Region
      • Installing Unity and the Breakroom SDK
      • Reducing poly counts on CAD files
      • Uploading a Region from Unity to Breakroom
      • Creating and uploading custom chairs
      • Testing items on the preview server
      • Pushing items to the live server
      • Installing the conference system components
    • Uploading your own virtual objects
    • Uploading your own virtual clothing
    • Creating and copying avatar shapes
    • Installing the Quest System
    • Registration and grid APIs
    • Video streaming
    • Sinespace scripting documentation
  • HELP
    • Where to find support
    • Tutorial video playlists
      • Platform basics
      • Dashboard
      • Moderator tools
      • Breakroom Games
      • Creator Core
      • Breakroom for Training - Students
      • Breakroom for Training - Instructors
      • Breakroom for Training - Dashboard and Backend
    • Account management
    • System requirements
    • Troubleshooting network ports and firewalls
  • RELEASE NOTES
    • Breakroom SDK
    • Breakroom Viewer
    • Breakroom Dashboard
Powered by GitBook

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

On this page
  • Overview
  • Breakroom Teleport Portal user controls
  • Setting up the Breakroom Teleport Portal
  • Editing the Breakroom Teleport Portal collider zone
Export as PDF
  1. CREATING CUSTOM EXPERIENCES
  2. Exploring the Breakroom Toolkit

Breakroom Teleport Portal

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

PreviousBreakroom Info KioskNextBreakroom Web Collab

Last updated 10 months ago

Overview

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

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

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

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 Region ID for the destination. This can be found on your Breakroom Dashboard.

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

    2. Locate the Region 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 utility of the teleport portal and creates a better user 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.

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. When you are satisfied, click the Save button to store your changes.

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

In your Inventory, you'll see the Breakroom Info Kiosk represented by this icon:

For help installing the Breakroom Teleport Portal, please review our information on using the .

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

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

Using the or the , move, rotate, and resize the collider to meet your specifications.

Explore window
Region Editor
World-
Region-level
installing
positioning
RoomFurniture component
Region Editor tools
Pictured: The Breakroom Teleport Portal end user controls.
Pictured: The Breakroom Teleport Portal control panel.
Pictured: A Region tile on the Breakroom Dashboard, with the Region ID displayed.
Pictured: The Region Editor, with a Breakroom Teleport Portal object selected. The transparent green box indicates the size and location of the collider zone. In the Objects window, you can see that the collider zone object is nested within the Breakroom Teleport Portal object.
Transform component