Using the Region Editor
Breakroom lets you build your space, your way. Use the Region Editor to add and remove objects, edit the sky presets, and undo your work so you can start all over again.
Breakroom's Region Editor gives world Owners and Administrators the power to edit existing regions and any items that they contain. Plaster your exhibition hall with eye-catching posters, brand your vendor booths, or add appealing personal touches like potted plants and comfy sofas—with the Region Editor, almost anything is possible.
The images and tables below are designed to serve as a concise overview of the Region Editor UI. After you've grown comfortable opening the Region Editor and utilizing the various tools and menus it contains, you can build on that foundation by reviewing the child pages in this section. There you'll learn more about placing and moving objects, and explore some of the Region Editor's advanced settings, such as creating custom atmospheric and sky effects.
Currently, when connecting to World Stream via AWS, you will not be able to drag your cursor when adjusting your camera view or working with object gizmos in the Region Editor. We apologize for the inconvenience.
To overcome this issue on Windows, press Ctrl + Shift + F8 on your keyboard to enable drag mode. To disable drag mode, press the Esc key.
To overcome this issue on macOS, press FN + Ctrl + Shift + F8 to enable drag mode. To disable drag mode, press the Esc key.
To open the Region Editor, click the Edit Region button located to the right of your bottom toolbar.
The location of the Edit Region button.
Once the Region Editor is launched, you'll see several new UI components appear on your screen. These tools give you the ability to inspect and edit different parts of your region. Let's take a look at each part of the Region Editor UI in greater detail.
The Region Editor UI consists of several windows and menus.
The Objects window lists all of the objects in your region. These objects are sorted into different floors, depending on who added them and when they were added.
The room floor (here labeled "Floor_roomfloor") contains any conference system components that you have permission to remove or edit, as well as any objects that you have manually placed in the scene from your own inventory.
Meanwhile, the region floor (here labeled "Town hall low poly") contains the individual 3D assets that comprise the region itself. The contents of this particular floor will vary from region to region.
Region floor objects were uploaded into Breakroom as a whole, as part of one cohesive region. You may be able to toggle visibility on some of these objects, or edit their settings if the original region uploader elected to make that possible. However, you may not be able to make changes to all of the region floor components.
All Breakroom region templates contain a HIDDEN FLOOR as part of the region floor. This floor contains the essential conference system components, and cannot be deleted or edited.
In the Objects window, you'll notice that the room and region floors have different icon sets associated with them. Here's a quick breakdown of what those icons mean.
The room floor, containing three items. Notice the icons on the right.
Icon | Function |
|---|---|
Eye | Toggling this icon changes the object's visibility without deleting it. If disabled, the object will not render (be visible to users), and any scripts it contains will not run. |
Lock | Toggling this icon locks or unlocks an item. Locked items cannot be moved within the scene, and no further changes can be made to their components. |
Trash | Clicking this icon deletes the item entirely from the region. |
The region floor, containing several items. Notice the icons on the right.
Icon | Function |
|---|---|
Eye | Toggling this icon changes the object's visibility without deleting it. If disabled, the object will not render (be visible to users), and any scripts it contains will not run. |
Lock | Toggling this icon locks or unlocks an item. Locked items cannot be moved within the scene, and no further changes can be made to their components. |
Reload | Clicking this icon reloads an item so that any changes will be pushed forward. |
The top of the Objects window.
You can use the drop-down menu located at the top of the Objects window to filter your objects by type. You can also search for a specific object using the search field.
The Inspector window displayed next to a selected object.
The Inspector window displays more information about the individual objects that make up your region. You can launch it by clicking an on item in the region while in the Region Editor, or by clicking on that item's name in the Objects window.
In the above image, a breakout room has been selected as the active object. You can see that the room is surrounded by a green collider box, and a translate gizmo (or movement compass) is hovering inside. In the Inspector window, you can see that this object contains a number of components. Expanding a component reveals details about this particular breakout room, such as its location and scale.
The Inspector window is an advanced tool that generally tells you what components exist within or on a selected object. If the object is a seat, it will contain a Seat Position component. If the object is a solid wall, it will have a Collider component so that avatars can't pass through it. If the object contains a Lua script, it will have a Script Runtime component attached to it. These individual components can be examined, managed, and potentially modified via the Inspector window.
All objects contain a Transform component which allows you to alter their rotation, position, and scale. This is useful to know, as it gives you a great amount of control over where objects appear in your region.
At the top of the window, you will notice an on/off toggle labeled with the object's name, as well as an "Is Active" checkbox option. These controls are the same. If the toggle is on/box is checked, the object is active and will be rendered and scripted in your region as normal. If the toggle is off/box is unchecked, the object (and all of its children) will not be rendered or scripted for users.
The Inventory window lists all of the virtual objects you currently own. There are two ways to place an object in your region while in the Region Editor.
- 1.Left click on the item in your Inventory window, and then hover your cursor over the ground in your region. You will see the item appear in real time. The item will follow your cursor, allowing you to position it. Click the left mouse button when you want to set the item down.
- 2.Left click and hold on the item in your Inventory window, and drag it into the region. Release the left mouse button, and your item will be placed in the indicated position.
You can switch between Icon view and List view in the Inventory window by clicking the pink View button (highlighted above). You can also use the Search field to find any items you need.
We provide you with a free starter bundle of region items that includes video players, web browsers, posters, and other media and branding assets to place within your region. You can also find unique items to dress up your region in the Breakroom Shop—such as stylish pieces of furniture, works of art, or quirky conversation starters.
The location of the Advanced button in the Region Editor function button tray.
Advanced settings can be accessed by clicking the Advanced button located in the function button tray. By editing these settings, you can:
- Change who owns the room floor.
- Change or reset region materials.*
- Change or reset region lighting.*
- Enable or disable region options.*
- Reset the region as a whole.
Some Advanced window settings, including materials and region options, are only available on certain Breakroom region templates.
The buttons in this toolbar will help you move and manipulate objects within your region. From left to right, here's a brief overview of what each button does. You'll find more comprehensive information about these tools in our editing and moving objects documentation.
Button | Function |
|---|---|
Move | Activates the translate gizmo, allowing you to move an object. (You can also toggle this by pressing the W key on your keyboard.) |
Rotate | Activates the rotate gizmo, allowing you to rotate an object. (You can also toggle this by pressing the E key on your keyboard.) |
Scale | Activates the scale gizmo, allowing you to resize an object. (You can also toggle this by pressing the R key on your keyboard.) |
Node Mode | If node mode is activated and "snap nodes" have been installed in both a region and an object, then objects will naturally snap into place when you move them. |
Grid Mode | With grid mode activated, you can orient objects on a local grid. |
Move Object to Camera | Moves the currently selected object to your camera position. |
Local Mode/Global Mode Toggle | With local mode activated, objects can be moved relative to their own position and rotation. With global mode activated, objects can be moved relative to the region itself. |
Center/Mesh Pivot Toggle | With center mode activated, gizmos will appear within the object's bounding box (or at their "center of mass"). With mesh pivot mode activated, gizmos will appear at the object's pivot point. |
Undo | Undo your last action. |
Redo | Redo your last undone action. |
Avatar Move | If enabled, this feature locks your avatar into place while you edit the room. Disabling it gives you the freedom to move your avatar around the room as you edit. |
If you have no object selected, the buttons pictured above will not appear. Once you select an object, these buttons give you the option to delete the object, duplicate it, or deselect all of your currently selected objects.
You can also delete a selected object by pressing the Delete key on your keyboard. You can duplicate a selected object by pressing Ctrl + D.
Button | Function |
|---|---|
Inventory | Calls up the Inventory window. |
Advanced | Calls up the Advanced window. |
Objects | Calls up the Objects window. |
Terrain | Launches the Terrain editing window. |
Sky | |
Floor menu | Allows you to select which floor items will be placed on. Set the drop-down menu to your desired floor, and any objects you set out will be "filed" under that floor in the Objects window. |
Save | Saves your region editing progress. |
Close | Closes the Region Editor. You will be asked whether you want to save your changes. |
Button | Function |
|---|---|
Reset Zones | Resets all voice zones (and related navigation UIs) in order to push forward any changes made in the Region Editor. |
Visibility | Toggles voice zone/object collider visibility on and off. Useful for when you want to edit the objects inside a voice zone without running into camera issues. |
Last modified 2mo ago