Interface RegionPlacementOptions

Create/return an empty Region if all shapes are skipped? Default: false.

Allow rotation of the Region? Default: true.

Attach the Region to Tokens? If true, the initial elevation range passed in data is relative to the attached Token. Default: false.

Create the Region? If false, the preview document is returned. Default: true. Non-GMs cannot create Regions while the game is paused.

Optional creation options. By default the creation option controlObject is true.

Called when the Region shape that is placed has changed.

Called when the pointer is moved and after starting the placement of the next shape on confirm and skip. This callback replaces the default behavior if false is returned. If false is returned, the callback should modify the passed shape and may additionally modify preview.document and set the render flags on preview corresponding to the applied changes.

Called when the mouse wheel is scrolled. This callback replaces the default behavior if false is returned. If false is returned, the callback should modify the shape and may additionally modify preview.document and set the render flags on preview corresponding to the applied changes.

Called at the end of the workflow before the Region documents are created/returned. This callback may return a falsely value other than undefined to prevent the Regions from being created/returned.

Called before the confirmation (left-click) of a shape placement. This callback may return false to prevent the placement of the Region shape and display a warning.

Called before skipping (right-click) of a shape placement. This callback may return false to prevent skipping of the Region shape and display a warning.