Settings

This wiki is outdated. Use this documentation for Lock View v2+.

Module Settings

In the module settings, as a GM you will find a button to open the user configuration screen, where you can configure your users.
You have the following options:

• Enable: Enables all features for the user (locks, autoscaling, etc), except for the viewbox
• Viewbox: Enables the viewbox for the user, and allows the view to be controlled
• Control: Allows the user to control enabled users (always enabled for the GM). This will give access to the control buttons (to enable/disable locks, view/edit viewboxes, etc)

Besides enabling these settings for each specific user, you can also override this and enable them based on their user role.

---

• Hide Control Button - Enabling this will hide the control button (on the left side of the screen). This can be useful if this control button is never used, and will prevent it from cluttering the screen.

All connected users will also see two more settings which are only relevant if 'Autoscaling' is set to 'Physical Gridsize' (see below), as these settings allow the module to calculate the correct grid scale.
These settings are:

• Screen Width - Fill in the physical screen width in mm or inch of the TV
• Gridsize - Fill in the desired gridsize in mm or inch (must be the same unit as 'Screen Width'). This is usually 25 mm or 1 inch

Scene Settings

In the scene configuration screen, you'll find a new Lock View section with the following settings:

• Pan Lock - Initial 'Pan Lock' setting
• Zoom Lock - Initial 'Zoom Lock' setting
• Bounding box: Initial 'Bounding Box' settings
• Autoscale - Automatically scales the screen
• Exclude Sidebar - Exclude the area behind the sidebar from the bounding box or autoscaling. This can be enabled because the sidebar can obscure parts of the map
• Blacken Sidebar - Blackens the background of the sidebar to prevent users from seeing outsie of the bounding box or canvas (only works if 'Exclude Sidebar' is enabled)
• Collapse Sidebar on Scene Load - Collapses the sidebar when the scene is loaded, mainly useful in combination with 'Hide UI on Sidebar Collapse'
• Hide UI Elements on Sidebar Collapse - Hides selected UI elements (such as the macro hotbar, scene navigation, etc) when the sidebar is lockView_collapsed, great for landing pages or splash screens. You can configure which elements to hide by pressing the 'cog' button next to the checkbox. By default all elements except for the sidebar are enabled. The 'Ctrl+u' hotkey can hide/unhide the elements in case they need to be accessed
• Force Initial View - Forces the view to the 'Initial View Position' after loading the scene. Only works if 'Autoscale' is set to 'Off' or 'Physical Gridsize'
• Configure Initial View Position button - The button is located to the right of the 'Force Initial View' checkbox. Pressing it opens the 'Configure Initial View Position dialog screen (see below)

Autoscale can be set to the following options:

• Off - Autoscale disabled
• Horizontal Fit - Automatically scales the scene to fit the browser window. Horizontal fit, so it may cut off vertical parts of the scene
• Vertical Fit - Automatically scales the scene to fit the browser window. Vertical fit, so it may cut off horizontal parts of the scene
• Automatic Fit (inside) - Automatically chooses horizontal or vertical fit so no non-image background will ever be seen
• Automatic Fit (outside) - Automatically chooses horizontal or vertical fit so the full background can be seen, but can show the padding (area outside of the background image)
• Physical Gridsize - Scales the scene so the on-screen gridsize corresponds with a real world value (for example 25mm or 1"). The gridsize is determined by setting the 'Screen Width' and 'Gridsize' in the module settings. These settings are local, which means that they can be different for each connected client

Note 1: The 'Pan Lock', 'Zoom Lock' and 'Bounding Box' settings determine the initial settings. These are applied when a scene is loaded, or after closing the scene configuration screen. After that, you can enable or disable them by pressing the control buttons (see below).
Note 2: 'Horizontal Fit', 'Vertical Fit', 'Automatic Fit' and 'Physical Gridsize' are applied when a scene is loaded, or after closing the scene configuration screen. After that, the user can zoom and pan around (if Zoom Lock or Pan Lock are disabled)

Configure Initial View Position

By pressing the 'Configure Initial View Position' button to the right of the 'Force Initial View' checkbox, a dialog box opens and a red box is drawn on the canvas. This red box corresponds with the 'Initial View Position' as set in the 'Ambience and Atmosphere' section of the 'Scene Configuration Screen'.
Pressing the 'move' icon at the top left of the red box moves the box around while pressing the 'scale' icon at the right bottom scales the box.

In the dialog box, you'll find the following values and buttons:

• Old initial view position - The old initial view position as it is currently set in the scene configuration
• New initial view position - The new initial view position as displayed by the red box. These values are user editable
• Size in grid spaces - The size of the view expressed in grid spaces. These values are user editable
• Set to physical gridsize - Scales the 'new initial view position' to correspond with the physical gridsize as set in the module settings
• Set to player view - By selecting the name of a player that's currently connected, you can set the initial view position to the view of that player by pressing 'Capture View'
• Snap to grid - Snaps the 'new initial view poisition' to the grid. With the dropdown menu you can select which corner of the box should be snapped to the grid

Note: The displayed red box has the aspect ratio of the your (the GM's) screen. This does not necessary correspond to the aspect ratio of your players' view. The center of the red box will correspond with the center of the players' view (it ignores the sidebar).
By pressing the 'Cancel', 'Save', or 'Close' button, you'll return to the scene configuration. Only when the 'Save' button is pressed the initial view position on the scene configuration will be updated.
Don't forget to save the scene configuration to have the new settings take effect.

Bounding Box

The bounding box function limits how much a user can zoom or pan. It needs to be enabled, either in the scene configuration screen, or using control buttons. This function ensures that they always stay within a defined box.
To enable the bounding box function on a scene load, you can enable the function in the scene configuration screen. The function can also be enabled on the fly by pressing the control button.

By default this box is the canvas size (size of your background image), so users will not see the background color and padding.
It is also possible to define a bounding box by drawing a rectangle (control buttons => drawing tools => draw rectangle). After drawing the rectangle, you can edit it (double clicking the rectangle) to set the rectangle as a bounding box. This can be done in the Lock View tab, where you have the following options:

• Disabled: The rectangle is not used as a bounding box
• Owned Tokens: Use the rectangle as bounding box if a token that's owned by the user is within the rectangle. You can set multiple rectangles to 'Owned Tokens'. Moving a token from one 'Owned Tokens' rectangle to another forces the view to the new rectangle. If you have multiple owned tokens in different 'Owned Tokens' rectangles, the bounding box will extend to fit all of these rectangles
• Always: The rectangle is always used as bounding box, also if no tokens are within the rectangle. This overrides all other rectangles. Only one rectangle should be set to 'Always'. If more rectangles are set to 'Always', only one is chosen