ProBuilder Preferences window | ProBuilder | 4.3.1
docs.unity3d.com
    Show / Hide Table of Contents

    ProBuilder Preferences window

    To define how you interact with ProBuilder, you can customize the user interface and how the tools work.

    Preferences Window

    ProBuilder provides the following preference sections, which you can change to suit your needs:

    • Experimental
    • General
    • Graphics
    • Mesh Editing
    • Mesh Settings
    • Shortcuts
    • Toolbar
    • UV Editor

    Experimental

    Use these settings to enable and disable ProBuilder experimental features.

    Warning: Experimental features are untested and might break your Project.

    Experimental section

    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 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.

    General

    Use these properties to set some basic options for ProBuilder.

    General section

    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 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:
    Scene information overlay
    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.

    Graphics section

    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.
    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.
    Depth Test Enable this option to render Vertex, Edge, and Face handles through geometry.
    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.

    Mesh Editing section

    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.

    Mesh Settings section

    Property: Description:
    Static Editor Flags Choose one of the Unity Static Settings as the default for new ProBuilder Meshes. The default value is Nothing.
    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.
    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 Vertex
    The pivot point of the newly instantiated object coincides with a vertex position.
    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 UV Settings Set defaults for the standard Lightmap UVs parameters. To return to the default settings, click the Reset button.

    Shortcuts

    Use these settings to change the key mappings for ProBuilder hotkeys.

    Shortcut Settings section

    To change the key mapping for one of these settings:

    1. Click the setting you want to change (for example, Set Pivot) in the list on the left.

      The Key and Modifiers drop-down menus on the right display the current setting, and the Description displays any information about the setting.

    2. Choose a new key value from the Key drop-down menu if you want to change the key itself. This can be anything you can press on the keyboard or console. For example, you can select joystick buttons or Backspace instead of alphanumeric characters.

    3. Choose a new modifier value from the Modifiers drop-down menu if you want to change the modifier.

      Caution: Be careful if you choose the Everything value, because this might override another value that uses the same key in a specific context.

    As soon as you change the Key or Modifiers value, ProBuilder saves the change. There is no Save button to commit the change and Undo does not affect these settings.

    Note: If something goes wrong, you can click the Reset All Preferences button at the top of the window to return to the default values. However, this resets all ProBuilder preferences to their default, so use this only as a last resort.

    Setting: Description: Default Key Assignment
    Toggle Geometry Mode Toggle between the Object and Element selection modes. G
    Toggle Selection Mode Toggle between the three Element selection modes (Vertex, Edge, and Face). If Unique Mode Shortcuts is disabled, this shortcut does not apply. H
    Set Trigger Set all selected objects to entity type Trigger. T
    Set Occluder Set all selected objects to entity type Occluder. O
    Set Collider Set all selected objects to entity type Collider. C
    Set Mover Set all selected objects to entity type Mover. M
    Set Detail Set all selected objects to entity type Brush. B
    Toggle Handle Orientation Toggle the orientation of the ProBuilder selection handle. P
    Set Pivot Center pivot around current selection. Cmd/Ctrl+J
    Delete Face Delete all selected faces. FN+Backspace
    Vertex Mode Enter Vertex editing mode. Automatically swaps to Element level editing. H
    Edge Mode Enter Edge editing mode. Automatically swaps to Element level editing. J
    Face Mode Enter Face editing mode. Automatically swaps to Element level editing. K

    Toolbar

    Use these properties to set default behavior for the ProBuilder toolbar.

    Toolbar section

    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.
    Unique Mode Shortcuts Enable this option to assign G, H, J, and K to Object, Vertex, Edge, and Face modes respectively. You can change which keys are mapped to these actions in the Shortcut Settings section.

    By default, ProBuilder assigns G to toggle between Object mode and the Element modes, and H toggles between the different Element modes (Vertex, Edge, and Face).
    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
    Close Shape Window after Build Enable this option to automatically close the Shape Tool window after it creates a new Mesh object.

    UV Editor

    Use these settings to customize the UV Editor window.

    UV Editor section

    Property: Description:
    Grid Size Size of the grid in the UV Editor, for visual and functional purposes.
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023