Menu
Lumberyard
User Guide (Version 1.14)

Customizing Lumberyard Editor

You can customize your workspace by adjusting how the windows and tools are docked, customizing which toolbars and menus display, and updating the global editor settings. To change the size setting for the toolbar icon, edit the ed_toolbarIconSize parameter in the Editor.cfg file. By default, the toolbar icon size is set to 0 (32 pixels).

Docking Windows and Toolbars

When you drag a window or toolbar over an interface element or the edges of the editor, docking targets appear to show you where you can dock them. These targets appear for the top, bottom, left, and right quadrants of the pane. You can dock windows relative to any open pane, whether it is already docked, floating as a tab, or split in a column or row.

To split a row or column

To split a row or column, drop the window or toolbar on a docking target.

Split the column into two panes

To dock a window or toolbar as a tab

To dock a window or toolbar as a tab, drop it on the docking target in the middle of a pane.

Dock the window into a tabbed view

To dock a window or toolbar to the editor window

To dock a window or toolbar to the editor window, drop it on the outer docking target. This creates a new column next to the existing column.

Dock the window to the editor window and create a new column

To undock a window or toolbar

To undock a window or toolbar, drag the title bar and move the selection window away. Avoid the docking targets to prevent from accidentally redocking the window. To help prevent accidental docking, a brief delay occurs before a docking target becomes active. You can also undock a window by right-clicking the title bar and choosing Undock.

Undock the window from the tabbed view

To prevent a window from docking

To prevent a window from docking, press and hold Ctrl while moving the window.

To snap windows

To snap a window in place, move the window close to a stationary window. Snapping works on the top, bottom, left, and right borders of the pane.

Customizing Toolbars and Menus

You can also give toolbars and menus your own personal touch.

To customize preset toolbars or create custom toolbars and menus

  1. Right-click the top toolbar and click Customize.

  2. In the Customize window, use the Toolbars tab to create, rename, and delete any custom toolbars and menus, and reset them to the default settings.

    
                        Toolbars tab in the Customize window
  3. Use the Commands tab to drag and drop menu commands to any menu category.

    
                        Commands tab in the Customize window

Changing Preferences

You can change the default settings to customize the look and functionality of the editor.

To customize the look and features of Lumberyard Editor

  • In Lumberyard Editor, choose Edit, Editor Settings, Global Preferences.

    
                        General Settings tab in the Preferences window

General Settings

You can change the general Lumberyard Editor settings and file settings.

General Settings

Parameter Description
Show Geometry Preview Panel Display a preview window for the selected object
Show Geometry Tree Browser Panel Display the geometry tree browser panel
Hide Objects by Config Spec Hide objects as determined by the minimal specifications and configuration specifications
Enable Source Control Enable Perforce version control
External Layers: Save Only Modified Save only the modified external layers
Freeze Read-only External Layer on Load Freeze the read-only external layers when loading the level
Frozen Layers are Selectable Allow objects in frozen layers to be selected
Console Background Change the background color for the console
Show Welcome to Lumberyard at Startup Display the Welcome to Lumberyard dialog box at startup
Autoload Last Level at Startup Load the level that was last loaded
Show Time in Console Display the time in the console window
Toolbar Icon Size Adjust the toolbar icon size; default = 0 (32 pixels)
Stylus Mode Enable stylus mode for tablets and other pointing devices
Enable Double-Clicking in Layer Editor Allow double-clicking in the Layer Editor
Undo Levels Specify the maximum number of times you can undo a level; default = 50
Range Adjust the distance from the cursor to include objects in deep selection; default = 1
Vertex Cube Size Adjust the vertex cube size
Render Penetrated Boundboxes Render penetrated bound boxes

Files Settings

Parameter Description
Backup on Save Create a backup file when you save
Maximum Save Backups Specify the maximum number of saved backups
Standard Temporary Directory Specify the default temporary directory to use; default = [root]\Temp
Auto Save Camera Tag Points Save the modified camera tag points
Scripts Editor Specify the text editor to use for scripts
Shaders Editor Specify the text editor to use for shaders
BSpace Editor Specify the text editor to use for blend spaces
Texture Editor Specify the program to use for textures
Animation Editor Specify the program to use for animations
Enable Enable auto backup
Time Interval Specify the frequency of auto backup (in minutes)
Maximum Backups Specify the maximum number of auto backups
Remind Time Specify the frequency of auto backup reminders (in minutes)

Viewport

You can change the default settings for the viewport.

General Settings

Parameter Description
Synchronize 2D Viewports Enable synchronization of 2D viewports to move and correspond with each other
Perspective View FOV Specify the field of vision for the viewport
Perspective View Aspect Ratio Specify the length of the aspect ratio for the viewport, where height = 1
Enable Right-Click Context Menu Enable or disable the context menu that displays by right-clicking in the viewport
Show 4:3 Aspect Ratio Frame Display a 4:3 aspect ratio frame to show what is visible in game mode
Highlight Selected Geometry Highlight the selected geometry
Highlight Selected Vegetation Highlight the selected vegetation
Highlight Geometry on Mouse Over Highlight geometry on hover over
Hide Cursor when Captured Show or hide the mouse pointer in the viewport
Drag Square Size Specify the size of the drag square to prevent from accidentally moving objects when selecting
Display Object Links Display entity links in the viewport
Display Animation Tracks Display the animation path for any objects in the Track View editor; one line = one frame
Always Show Radii Display the area of effect (radius) for certain entities
Always Show Prefab Bounds Display the prefab boundary helpers
Always Show Prefab Objects Display the prefab object helpers
Show Bounding Boxes Display a bounding box around each object
Always Draw Entity Labels Display entity names
Always Show Trigger Bounds Display the trigger boundary helpers
Show Object Icons Display object icons
Scale Object Icons with Distance Scale object icons relative to distance
Show Helpers of Frozen Objects Display the frozen object helper icons
Fill Selected Shapes Highlight the inside area of a selected shape
Show Snapping Grid Guide Display the grid in the viewport
Display Dimension Figures Display the measurement dimensions of selected assets; you must enable helpers
Swap X/Y Axis Reverse the x-axis and y-axis
Map Texture Resolution Specify the resolution for the displayed map
Enabled Display object names
Distance Specify the visibility distance for text labels
Prefab Bounding Box Specify the color for the prefab bounding box
Group Bounding Box Specify the color for the group bounding box
Entity Bounding Box Specify the color for the entity bounding box
Bounding Box Highlight Alpha Specify the amount of highlight alpha to add to the bounding box
Geometry Color Specify the geometry color
Solid Brush Geometry Color Specify the color of the solid brush geometry
Geometry Highlight Alpha Specify the amount of highlight alpha to add to the geometry
Child Geometry Highlight Alpha Specify the amount of highlight alpha to add to the child geometry

Movement Settings

Parameter Description
Camera Movement Speed Specify the speed of all movements in the viewport
Camera Rotation Speed Specify the speed of movement while you control the viewport camera
Fast Movement Scale Specify the multiplier for the camera speed; for example, a value of two doubles the movement speed of the camera
Wheel Zoom Speed Specify the speed of the camera zoom when using the mouse wheel
Invert Y Axis Invert the direction that the camera moves on the y-axis when holding the right button on the mouse and moving the mouse up or down
Invert Pan Invert the direction that the camera moves when holding the middle button on the mouse and moving the mouse left or right

Gizmos Settings

Parameter Description
Size Specify the size of the xyz-axes gizmo
Text Labels Display the xyz-axes labels
Max Count Specify the maximum number of xyz-axes gizmos that can display onscreen at one time
Helpers Scale Specify the size of onscreen helpers, including AIAnchors, Tagpoints, and CoverSurfaces
Tagpoint Scale Multiplier Specify the scale of the tagpoint helper sphere and the base helper scale value
Ruler Sphere Scale Specify the scale of the locator sphere size when using the Ruler tool
Ruler Sphere Transparency Specify the transparency level of the locator sphere when using the Ruler tool

Debug Settings

Parameter Description
Show Mesh Statistics Display the level of detail information, such as tris and verts, for selectable objects
Warning Icons Draw Distance Specify the distance to which to display warning icons in the viewport
Show Scale Warnings Display an icon and warning text for objects that have been scaled
Show Rotation Warnings Display an icon and warning text for objects that have been scaled

Flow Graph

You can change the default settings for the Flow Graph editor.

General Settings

Parameter Description
Automatic Migration Update and reconnect port connection changes
Show NodeIDs Display an identifier for each node
Show Tooltip Display a tooltip for each node on pause over
Edges on Top of Nodes Enable edges on top of nodes
Highlight Edges of Selected Nodes Highlight the incoming and outgoing edges for the selected nodes

Color Settings

Specify the colors to use for the following elements in the Flow Graph editor:

  • Arrows

  • Highlight for the in and out arrows

  • Highlight for the port edges

  • Node outlines

  • Node backgrounds

  • Backgrounds for custom nodes

  • Selected nodes

  • Title text

  • Text

  • Backgrounds

  • Grids

  • Breakpoints

  • Entity ports

  • Ports

  • Quick search backgrounds and text

  • Debug node backgrounds and titles

Mannequin

You can change the default settings for the Mannequin system.

General Settings

Parameter Description
Size of Tracks Specify the height of the tracks for the dope sheet; minimum = 14, maximum = 32
Ctrl to Snap Scrubbing Snap scrubbing by pressing and holding the Ctrl key
Timeline Wheel Zoom Speed Specify the speed of the mouse wheel when zooming on the Mannequin timeline

Experimental Features

You can change the default settings for experimental features such as total illumination.

Lighting Settings

Parameter Description
Total Illumination Enable the total illumination lighting feature