Breakroom's built-in tour camera system can help you boost visitor engagement and streamline the orientation process. Read on for information about designing custom visual tours of your region.
The Breakroom Tour Camera system allows you to design and implement customized visual tours of your region. This powerful tool can be used to highlight networking areas, visually illustrate the steps necessary to complete a task, or generate excitement about the various activities available in a particular region—the possibilities are endless.
In your inventory, you will see the Breakroom Tour Camera system represented by this icon:
To install this object in your region, see the instructions below or consult our Region Editor documentation.
Users can launch your custom region tour at any time by clicking the Take Tour button in the Start Here UI. To exit the tour at any point, they can press the Esc key.
If you do not have the Start Here UI installed in your region, users will not have access to the Take Tour button. If you prefer, you can trigger your tour using a Lua script. Please note that Breakroom does not offer individualized Lua support.
To add the Breakroom Tour Cameras object to your region, follow the quick-guide steps below. You can also consult our Region Editor documentation for more tips and tricks.
Click the Edit Region button located at the bottom of your screen.
Click the Inventory button in the bottom right toolbar.
Search for the Breakroom Tour Cameras object in your inventory, and drag it into your region.
The primary Breakroom Tour Cameras object does not need to be located close to the areas you want to film. It can be located anywhere in your region. For convenience and consistency, we recommend that you manually edit the object's Transform component value to set it at the 0,0,0 location in your region.
The Breakroom Tour Cameras object contains several preconfigured cameras that can be set up in your region. You can use one or all of these cameras to create your custom region tour—the choice is up to you.
You can locate the tour camera system's individual cameras by following the steps below.
Click the Edit Region button located at the bottom of your screen.
Click the Objects button in the bottom right toolbar.
In the Objects window, search for the Breakroom Tour Cameras object.
Click the > arrow located to the left of the Breakroom Tour Cameras object to expand it, and locate the Cameras object.
Click the > arrow located to the left of the Cameras object to expand it.
Each camera type offers a unique approach to viewing your region.
Each camera in the Breakroom Camera Tour object can be activated or deactivated as necessary. If a camera is active, then its "view" will be included in your custom tour. If a camera is deactivated, it will not be included in your custom tour.
To activate a camera, click the eye icon located to the right of its name. (When active, the eye icon will appear bright white.) To deactivate a camera, click the eye icon again (when deactivated, the camera's name and its icon set will appear grayed out).
The Breakroom Tour Cameras can be edited in a variety of ways to achieve dramatic effects.
While the Breakroom Tour Cameras object can be placed at 0,0,0 in your region, the individual tour cameras must be moved into position to capture the scenes you want to include in your tour. Many of the camera types include arrows and other markers designed to help with positioning.
Here we see a close-up of the Pan Left Camera, with arrows indicating the direction the camera is facing and the path it will follow. The camera's track is highlighted in green.
Here we see the Zoom Out Camera, with icons indicating the camera focus point (the mountain) and the path and direction the camera will travel (down the highlighted green track, pulling away from its starting point).
Here we see the Orbit Camera, where the camera focus point (the mountain) will remain in the center. The camera will circle this focus point.
To edit the position of individual cameras in your region, follow these steps.
Click the Edit Region button located at the bottom of your screen.
Click the Objects button in the bottom right toolbar.
In the Objects window, search for the Breakroom Tour Cameras object.
Click the > arrow located to the left of the Breakroom Tour Cameras object to expand it, and locate the Cameras object.
Click the > arrow located to the left of the Cameras object to expand it.
Click on the individual tour camera you want to position in order to highlight it.
Use the Region Editor's object positioning and editing tools to place the tour camera where you want it. Alternatively, you can manually edit the tour camera's Transform values.
When you are satisfied, click the Save and Close buttons.
You can test your chosen placement and effects by clicking the Take Tour button located in the Start Here UI.
You can use the "Move Object to Camera" button located in the bottom toolbar of the Region Editor to snap a tour camera object to your current camera position (the live camera that you personally control with your mouse and keyboard).
For this tip, we will refer to the individual tour camera object that you want to move as the tour camera, and your own user camera as the working camera.
Each tour camera type will react differently to the position of your working camera.
To position a tour camera using the "Move Object to Camera" function, follow these steps.
Click the Edit Region button located at the bottom of your screen.
Click the Objects button in the bottom right toolbar.
In the Objects window, search for the Breakroom Tour Cameras object.
Click the > arrow located to the left of the Breakroom Tour Cameras object to expand it, and locate the Cameras object.
Click the > arrow located to the left of the Cameras object to expand it.
Click on the individual tour camera you want to position in order to highlight it.
Leaving the tour camera selected, move your live camera into position.
Click the "Move Object to Camera" button located in the bottom toolbar. The tour camera will snap into place.
When you are satisfied, click the Save and Close buttons.
Some individual Breakroom Tour Cameras offer the ability to position the camera focal point independent of the camera track. By changing the relation of the camera's focal point with its animated track, you can achieve unique customized effects.
To position a tour camera's focal point and track independently of one another, follow the steps below.
Click the Edit Region button located at the bottom of your screen.
Click the Objects button in the bottom right toolbar.
In the Objects window, search for the Breakroom Tour Cameras object.
Click the > arrow located to the left of the Breakroom Tour Cameras object to expand it, and locate the Cameras object.
Click the > arrow located to the left of the Cameras object to expand it.
Click on the individual tour camera you want to edit in order to highlight it.
Click the > arrow located to the left of the individual tour camera to expand it. (Note: Not all Breakroom Tour Cameras include a modifiable focal point.)
Click on the Focus or Track object to highlight it. A translation gizmo will superimpose over your chosen object.
Use the Region Editor's object positioning and editing tools to place the Focus or Track where you want it. Alternatively, you can manually edit the tour camera's Transform values or use the "Move Object to Camera" feature detailed above.
When you are satisfied, click the Save and Close buttons.
In addition to editing their physical placement, there are a number of transition and speed options available within each tour camera object. By modifying these, you can add additional interest and drama to your custom region tour.
To locate these options, follow the steps below.
Click the Edit Region button located at the bottom of your screen.
Click the Objects button in the bottom right toolbar.
In the Objects window, search for the Breakroom Tour Cameras object.
Click the > arrow located to the left of the Breakroom Tour Cameras object to expand it, and locate the Cameras object.
Click the > arrow located to the left of the Cameras object to expand it.
Click on the individual tour camera you want to edit in order to highlight it. The Inspector window will launch for that object.
Click the > arrow located to the left of the ScriptingData component.
All of the options under the ScriptingData component can be manually edited by keying words or values into their respective fields. Here is a quick reference chart to get you started.
Currently, Breakroom Tour Cameras support eight different transition types.
Once you have made your changes, click the Save and Close buttons located in the bottom right corner of your screen.
There are additional customization options available under the RoomFurniture component attached to the Breakroom Tour Cameras main object. To locate these, follow the steps below.
Click the Edit Region button located at the bottom of your screen.
Click the Objects button in the bottom right toolbar.
In the Objects window, search for the Breakroom Tour Cameras object. Click on it in order to highlight it. The Inspector window will launch for that object.
Click the > arrow located to the left of the RoomFurniture component.
Here is a quickstart guide to the options contained under the RoomFurniture component.
Once you have made your changes, click the Save and Close buttons located in the bottom right corner of your screen.
| Camera type | Behavior |
|---|---|
| Tour camera type | "Move Object to Camera" behavior |
|---|---|
| ScriptingData camera option | Purpose or result |
|---|---|
| Transition | Effect |
|---|---|
| RoomFurniture component option | Purpose or effect |
|---|---|
Orbit
Performs a close-end 360° orbit around a center focal point.
Wide Orbit
Performs a wider 360° orbit around a center focal point.
Zoom In
"Pushes in" along a fixed track.
Zoom Out
"Pulls out" along a fixed track.
Pan Right
Shifts from left to right along a fixed track.
Pan Left
Shifts from right to left along a fixed track.
Orbit/Wide Orbit Cameras
The camera focus will snap to the location of your working camera.
Zoom In Camera
The camera track's start point will snap to the location of your working camera.
Zoom Out Camera
The camera track's end point will snap to the location of your working camera.
Pan Right/Left Cameras
The camera track's center point will snap to the location of your working camera.
Speed
By default, each tour camera takes 5 seconds to move along its associated track. By editing the multiplier value in this field, you can change how fast that individual camera travels during your tour. (For example, entering a value of 0.5 would halve the default speed. The camera would then take 10 seconds to travel along its track.)
FOV (Field of View)
FOV refers to how much of the region an individual tour camera can see, or how focused that camera is on a particular object or scene. The default value is 50. The lower the number, the more focused the camera will be. If you "pull out" the camera too much (beyond a field value of 70-75), you may see a fisheye distortion.
Caption
You can use this field to enter a caption for each individual camera view, which will then be displayed at the bottom of the screen. If this field is blank, no words will appear at the bottom of the screen.
Order
This option refers to the camera order in your final tour. The default value is 1, which means that all cameras have the same priority. Therefore, they will be played in the same order as they appear in the Objects window. You can manually order your chosen tour cameras by assigning them individual numbers, or you can create priority groups that will then play in the order in which they appear in the Objects window. (E.g. all priority 1s play first, then all priority 2s, etc.)
Transition
Here you can change how each tour camera view transitions into the one that follows. Transition options are described in more detail below.
Loops (only on Orbit Cameras)
This value refers to the number of times the camera travels along its circular track, and defaults to 1. You can edit this value to make the camera complete multiple loops (ex: 3) or partial loops (ex: 0.5, which would be a 180° arc).
Fade White
A blended fade into the next scene through a white screen.
Fade Black
Same as above, but with a black screen.
Wipe White
A horizontal wipe into the next scene through a white screen.
Wipe Black
Same as above, but with a black screen.
Door White
A close shot into the middle, then opening up from the middle into the next scene, through a white background.
Door Black
Same as above, but with a black background.
Spin White
A spinning effect into the next scene through a white screen.
Spin Black
Same as above, but with a black screen.
Hide Interface
If ticked, this option hides the Breakroom UI while the tour is playing.
Randomize Cameras
If ticked, enabled cameras will play in random order for each tour.
Intro Transition
This field can be changed to any of the transition options described above.
Outro Transition
This field can be changed to any of the transition options described above.
