Skip to content

Lock View Documentation

Work In Progress

This documentation is still a work in progress. It is currently mostly done, but there are some sections missing. For the missing sections please refer to the old documentation which is (mostly) still relevant.


Lock View v2 only

This documentation is for Lock View v2.0.0+. Refer to the old documentation for older versions of Lock View.


Welcome to the Lock View documentation.
Click the links above to navigate the documentation.
Make sure you start here.

Introduction

Lock View is a Foundry VTT module that provides the GM or a designated player with options to control how Foundry is displayed and controlled. The main features include:

  • Autoscaling: Autoscaling the scene so it fills the display or scaled so the grid corresponds with physical dimensions.
  • Locks: Pan & zoom locks to prevent users from panning or zooming, or force their view to stay within a specified bounding box.
  • Force Initial View: Make sure that a scene loads to a specified view position and scale.
  • Viewbox: Allows the GM to see the view of users, represented by rectangles drawn on the canvas.
  • Panning & Zooming User Views: Move a user's view to a specific point, or offset it by a specific amount of grid spaces.
  • Cloning View: Apply your current view to users.

Getting Started

New Users: Please Read

When first starting out with Lock View, it can be a bit confusing and daunting. While effort has been put into making everything as easy to understand as possible, due to the amount of things the module can do, some confusion might still arise.
Please read (at least) this page very carefully.


Core Concepts

Scene Settings

Almost all Lock View features are configured on a scene-by-scene basis (it is possible to configure default settings). These settings can be set in the scene's configuration. Additionally Lock View's scene configurator allows for quick editing for multiple scenes.

User Settings

The various functions Lock View can be enabled or disabled for specific users in the User Configurator by the gamemaster. For the module to have any effect on a user, at least one of the settings needs to be enabled.
In the module and this documentation, references are made to Enable users or Control users, which means users that have Enable or Control enabled, respectively.

Locks

One of the main parts of the module is the locks functionality. Locks are used to prevent Enable users from panning, zooming, or it can limit a player's view to a specified bounding box.
Locks are configured on a scene-by-scene basis, and they can be changed by pressing the relevant control buttons.

Control Buttons

Lock View's control buttons give quick access to some of its features.

Viewbox

The viewbox allows Control users to see what Viewbox users are seeing by drawing a rectangle representing the view on the canvas. Additionally, Control users can edit the viewbox, which means that they can control what Viewbox users see.

Autoscaling

Lock View provides multiple autoscaling options in the scene configuration that will automatically set the scale/zoom level for Enable users. For example, it is possible to fit the scene so the entire scene is visible, or set a physical grid size and have scene scaled so it's grid corresponds with real world dimensions.

Example Configurations

Example configurations for common usecases can be found here.