ProBuilder Preferences window
To define how you interact with ProBuilder, you can customize the user interface and how the tools work.
ProBuilder provides the following preference sections, which you can change to suit your needs:
- Dimensions Overlay
- Experimental
- General
- Graphics
- Mesh Editing
- Mesh Settings
- Snap Settings
- Toolbar
- UV Editor
Dimensions Overlay
Use this setting to customize the Dimensions Overlay.
By default, the overlay shows the dimensions of the selected Mesh elements only, but you can use the Bounds Display property to change this to show the dimensions of the select GameObjects, regardless of what elements (vertices, edges, or faces) are selected.
Property: | Description: |
---|---|
Object | Select this option to use the selected object(s) to calculate the dimensions of the world space bounds for the information that appears on the overlay. |
Element | Select this option to use the selected element(s) to calculate the dimensions of the world space bounds for the information that appears on the overlay. This is the default. |
Experimental
Use these settings to enable and disable ProBuilder experimental features.
Warning: Experimental features are untested and might break your Project.
Property: | Description: |
---|---|
Experimental Features Enabled | Enable this option to access the New Bezier Shape experimental feature in the ProBuilder toolbar, and the Store Mesh as Asset option. Note: This setting has no affect on access to the Boolean (CSG) Tool, which is always available from the Experimental menu. |
Meshes Are Assets | Enable this option to store Mesh information in the Project instead of in each separate Scene level. |
Note: When you toggle Experimental Features on or off, Unity has to recompile scripts because the changes add or remove functionality in Unity. This means that there is a delay before this option appears to change.
General
Use these properties to set some basic options for ProBuilder.
Property: | Description: |
---|---|
Show Action Notifications | Enable this option if you want ProBuilder to notify you when performing actions. |
Auto Lightmap UVs | Enable this option to generate the UV2 channel after every geometry edit. This means you don't have to manually generate them every time the Mesh changes. UV2 channel generation for Meshes is necessary for lighting, but can be time-consuming. If you are editing objects with large numbers of vertices, disable this to save resources. |
Show Missing Lightmap UVs Warning | Enable this option to show a warning in the console if ProBuilder shapes are missing a valid UV2 channel when Unity performs a lightmap bake. |
Show Handle Info | Enable this option to display the information for moving, rotating, and scaling deltas in the bottom right of the Scene view. Note: If you have the Component Editor Tools panel open in the Scene view, it covers this information. Close the panel to display the information. |
Show Scene Info | Enable this option to display the Mesh information overlay in the top left of the Scene view. These details include overall face, vertex and triangle counts, and the number of elements currently selected: |
Script Stripping | Enable this option to automatically remove the extra data ProBuilder stores in a Scene. This includes all ProBuilder scripts, so if you are using the runtime API you should disable this feature. |
Graphics
Use these settings to customize the size and color of Mesh elements.
By default, the Use Unity Colors option is enabled. However, you can disable this option to set custom colors for a number of elements.
Property: | Description: |
---|---|
Show Hover Highlight | Enable this option to highlight the closest Mesh elements when your cursor moves towards them. Tip: You can also set the color to use for highlighting with the Preselection property. |
Selection X-Ray | Enable this option to display any selected hidden geometry. |
Use Unity Colors | Enable this property to use the standard Unity Color preferences. By default, this property is enabled. When you disable this option, a number of properties appear below. These allow you to specify your own colors to use instead of the Unity colors. For example, you can specify different colors for selected and unselected faces, edges, and vertices. |
Dither Face Overlay | Enable this option to use dithering (dotted overlay) when you hover over or select items. If you disable this option, the overlay appears solid instead. This property is only available when Use Unity Colors is disabled. |
Wireframe | Pick the color ProBuilder uses to display the Mesh's wireframe. This property is only available when Use Unity Colors is disabled. |
Preselection | Pick the color ProBuilder uses to highlight the closest Mesh element. The Show Preselection Highlight property must be enabled in order to display highlights. This property is only available when Use Unity Colors is disabled. |
Selected Face Color | Pick the color ProBuilder uses to display the selected face(s) in a ProBuilder Mesh. This property is only available when Use Unity Colors is disabled. |
Unselected Edge Color | Pick the color ProBuilder uses to display the unselected edges in a ProBuilder Mesh. This property is only available when Use Unity Colors is disabled. |
Selected Edge Color | Pick the color ProBuilder uses to display the selected edge(s) in a ProBuilder Mesh. This property is only available when Use Unity Colors is disabled. |
Unselected Vertex Color | Pick the color ProBuilder uses to display the unselected vertices in a ProBuilder Mesh. This property is only available when Use Unity Colors is disabled. |
Selected Vertex Color | Pick the color ProBuilder uses to display the selected vertex (or vertices) in a ProBuilder Mesh. This property is only available when Use Unity Colors is disabled. |
Vertex Size | Set the size to render the vertex points on ProBuilder Meshes in the Scene view. |
Line Size | Set the size to render the edges on ProBuilder Meshes in the Scene view. Note: On macOS, this property is only available if you use OpenGL instead of Metal. |
Wireframe Size | Set the size to render the ProBuilder Mesh wireframe in the Scene view. Note: On macOS, this property is only available if you use OpenGL instead of Metal. |
Mesh Editing
Use these settings to customize interacting with Meshes.
Property: | Description: |
---|---|
Auto Resize Colliders | Enable this option to automatically resize colliders according to Mesh bounds as you edit. |
Allow non-manifold actions | Enable this option if you want to edit your Meshes with advanced techniques, such as bridging closed edges. Note that these complex actions can break your project unless you are familiar with their concepts and how to apply them. By default, this option is disabled. |
Mesh Settings
Use these settings to establish default behavior for some ProBuilder options.
Property: | Description: | |
---|---|---|
Material | Set a reference to the default Material you want to use for ProBuilder Meshes. By default, ProBuilder uses the ProBuilderDefault Material when creating new Meshes. | |
Static Editor Flags | Choose one of the Unity Static Settings as the default for new ProBuilder Meshes. The default value is Nothing. | |
Mesh Collider is Convex | Enable this option to set the default convex collider state for new ProBuilder objects. | |
Pivot Location | Choose the default pivot location for new ProBuilder objects. | |
First Corner | Use the "first corner" as the pivot point for the newly created Mesh. The first corner refers to where you first clicked in the Scene view to create it. | |
Center | Use the center of the newly instantiated object as the pivot point. | |
Snap New Shape To Grid | Enable this option to snap a newly instantiated object to the nearest grid point (as determined by ProGrids). | |
Shadow Casting Mode | Choose how new ProBuilder Meshes cast shadows. The default value is Two Sided. See the Cast Shadows property on the Mesh Renderer component for more information on this setting. |
|
Collider Type | Set the default type of collision primitive to use for new ProBuilder objects. The default is Mesh Collider. | |
None | Do not use a collider. | |
Box Collider | Use a basic cube for the collider. | |
Mesh Collider | Use a custom shape collider to match the newly created Mesh. This is the default. | |
Lightmap UVs Settings | Set defaults for the standard Lightmap UVs parameters. To return to the default settings, click the Reset button. |
Snap Settings
Use these properties to customize how snapping behaves with ProBuilder.
Property: | Description: | |
---|---|---|
Snap As Group | Enable this option if you want each selected item to keep the same relative position to each other while snapping. This is the default. Disable this option to snap each selected item to the grid independently. | |
Snap Axis | Choose how vertices snap to the grid while moving. | |
Active Axis | Vertices snap only along the currently active axis. This is the default. | |
All Axes | Vertices snap to all axes simultaneously. |
Toolbar
Use these properties to set default behavior for the ProBuilder toolbar.
Property: | Description: |
---|---|
Shift Key Tooltips | Enable this option to only show tooltips when the mouse cursor is hovering over a button and you are holding down Shift. By default, tooltips appear when the mouse cursor hovers over a button for more than a second. |
Icon GUI | Enable this option to use toolbar buttons that display icons only. Disable this option to use toolbar buttons that display text only. Note: You can also use the context menu to switch between icons and text. |
Toolbar Location | Choose the location where you want the Edit Mode toolbar to appear in the Scene view. Possible locations are: - Upper Center - Upper Left - Upper Right - Bottom Center - Bottom Left - Bottom Right |
UV Editor
Use this setting to customize the UV Editor window.
Property: | Description: |
---|---|
Grid Size | Size of the grid in the UV Editor, for visual and functional purposes. |