Internal_Preview container for config previews
Internal_The highlight meshes of the Regions.
Internal_The mouse wheel context.
Internal_The placement context.
Internal_The shape clipboard.
Internal_A throttled function that rotates many placeables.
Keep track of objects copied with CTRL+C/X which can be pasted later.
Track whether "highlight all objects" is currently active
Keep track of history so that CTRL+Z can undo changes.
Whether this event target has any children that need UI events. This can be used optimize event propagation.
Placeable Layer Objects
Options for this layer instance.
Preview Object Placement
A Quadtree which partitions and organizes Walls into quadrants for efficient target identification.
StaticdocumentStaticpaletteStaticSORT_Sort order for placeables belonging to this layer.
StaticTOGGLE_The shared palette tool.
Is this layer currently active
An Array of placeable objects in this layer which have the _controlled attribute
Track the set of PlaceableObjects on this layer which are currently controlled.
Obtain a reference to the Collection of embedded Document instances within the currently viewed Scene
To know wheter this layer has a preview object or not.
Track the PlaceableObject on this layer which is currently hovered upon.
If objects on this PlaceablesLayer have a HUD UI, provide a reference to its instance
The default creation data sourced from this layer's palette, if it has one.
A convenience method for accessing the placeable object instances contained in this layer
Is Measured Template Mode enabled?
StaticinstanceReturn a reference to the active instance of this canvas layer
StaticlayerStaticplaceableObtain a reference to the PlaceableObject class definition which represents the Document type in this layer.
InternalCancel the placement.
InternalCreate a preview of this layer's object type from a world document and show its sheet to be finalized.
The data to create the object with.
Optionaloptions: { left?: number; renderSheet?: boolean; top?: number } = {}Options which configure preview creation
Optionalleft?: numberThe offset-left position where the sheet should be rendered
OptionalrenderSheet?: booleanRender the preview object config sheet?
Optionaltop?: numberThe offset-top position where the sheet should be rendered
The created preview object
InternalAn internal helper method to identify the array of PlaceableObjects which can be copied/cut.
Additional options
Cut instead of copy?
An array of objects which can be copied/cut
InternalAn internal helper method to identify the array of PlaceableObjects which can be moved or rotated.
An explicit array of IDs requested.
Include locked objects which would otherwise be ignored?
An array of objects which can be moved or rotated
InternalHighlight the shape or clear the highlight.
The shape to highlight, or null to clear the highlight
InternalPrepare the updates and update options for moving the given placeable objects via keyboard.
InternalPrepare the updates and update options for rotating the given placeable objects via keyboard.
InternalSend the controlled objects of this layer to the back or bring them to the front.
Bring to front instead of send to back?
Returns undefined if the layer does not have sortable object. Returns false if the controlled objects are already at the front/back.
Rotate the shape of the preview.
The mouse wheel event
Activate the InteractionLayer, deactivating other layers and marking this layer's children as interactive.
Optionaloptions: { tool?: string } = {}Options which configure layer activation
Optionaltool?: stringA specific tool in the control palette to set as active
The layer instance, now activated
Clear the contents of the preview container, restoring visibility of original (non-preview) objects.
Acquire control over all PlaceableObject instances which are visible and controllable within the layer.
Options passed to the control method of each object
An array of objects that were controlled
Iterates over placeable objects that are eligible for control/select.
Draw a single placeable object
The Document instance used to create the placeable object
Deactivate the InteractionLayer, removing interactivity from its children.
The layer instance, now inactive
A helper method to prompt for deletion of all PlaceableObject instances within the Scene Renders a confirmation dialogue to confirm with the requester that all objects will be deleted
An array of Document objects which were deleted by the operation
Draw the canvas layer, rendering its internal components and returning a Promise. The Promise resolves to the drawn layer once its contents are successfully rendered.
Optionaloptions: object = {}Options which configure how the layer is drawn
Get a PlaceableObject contained in this layer by its ID. Returns undefined if the object doesn't exist or if the canvas is not rendering a Scene.
The ID of the contained object to retrieve
The object instance, or undefined
Get the maximum sort value of all placeables.
The maximum sort value (-Infinity if there are no objects)
Simultaneously move multiple PlaceableObjects via keyboard movement offsets. This executes a single database operation using Scene#updateEmbeddedDocuments.
Options which configure how multiple objects are moved
Optionaldx?: 0 | 1 | -1Horizontal movement direction
Optionaldy?: 0 | 1 | -1Vertical movement direction
Optionaldz?: 0 | 1 | -1Movement direction along the z-axis (elevation)
Optionalids?: string[]An Array of object IDs to target for movement. The default is the IDs of controlled objects.
OptionalincludeLocked?: booleanMove objects whose documents are locked?
Optionalrotate?: booleanRotate the placeable to direction instead of moving
An array of objects which were moved during the operation
Paste currently copied PlaceableObjects back to the layer by creating new copies
The destination position for the copied data.
Optionaloptions: { hidden?: boolean; snap?: boolean } = {}Options which modify the paste operation
Optionalhidden?: booleanPaste data in a hidden state, if applicable. Default is false.
Optionalsnap?: booleanSnap the resulting objects to the grid. Default is true.
An Array of created Document instances
Place a Region at the cursor.
The Region can have multiple shapes, but none of them can be holes and it must have at least one shape.
Each shape is placed one after the other in the given order.
Only one Region can be placed at a time.
The placed Region shapes can be rotated with the mouse wheel unless allowRotation is false.
Left-click confirms the placement of a shape. Right-click skips the placement of a shape.
The data of the Region to place
Optionaloptions: {Additional options
OptionalallowRotation?: booleanAllow rotation of the Region? Default: true.
OptionalattachToToken?: booleanAttach the Region to Tokens? If true, the initial elevation range
passed in data is relative to the attached Token. Default: false.
Optionalcreate?: booleanCreate the Region? If false, the preview document is returned.
Default: true. Non-GMs cannot create Regions while the game is paused.
OptionalcreateOptions?: Partial<Omit<DatabaseCreateOperation, "parent">>Optional creation options.
By default the creation option controlObject is true.
The Region document that was placed or null if
create option is true, orconst radius = 40 * canvas.dimensions.distancePixels;
const shapes = [];
for ( let i = 0; i < 4; i++ ) shapes.push({type: "circle", x: 0, y: 0, radius, gridBased: true});
await canvas.regions.placeRegion({
name: "Meteor Swarm",
shapes,
color: game.user.color,
restriction: {enabled: true},
levels: [canvas.level.id],
highlightMode: "coverage",
displayMeasurements: true,
visibility: CONST.REGION_VISIBILITY.OBSERVER,
ownership: {[game.user.id]: CONST.DOCUMENT_OWNERSHIP_LEVELS.OWNER}
});
ui.notifications.info("Choose the placement for the spawn area.");
const spawnArea = await canvas.regions.placeRegion({
name: "Spawn Area",
shapes: [{
type: "circle",
x: 0,
y: 0,
radius: canvas.dimensions.distancePixels * 30
}],
restriction: {enabled: true},
levels: [canvas.level.id]
}, {create: false});
if ( spawnArea ) {
const {count: numTokensToSpawn=0} = await foundry.applications.api.DialogV2.input({
window: {
title: "How many tokens to you want to spawn?"
},
content: `<input type="number" name="count" min="0" step="1" value="10">`
}) ?? {};
const actors = game.actors.contents;
const tokensToSpawn = [];
for ( let i = 0; i < numTokensToSpawn; i++ ) {
const actor = actors[Math.floor(Math.random() * actors.length)];
const token = await actor.getTokenDocument({
rotation: Math.random() * 360
}, {parent: spawnArea.parent});
tokensToSpawn.push(token);
}
const spawnedTokens = await spawnArea.spawnTokens(tokensToSpawn);
}
Release all controlled PlaceableObject instance from this layer.
Options passed to the release method of each object
The number of PlaceableObject instances which were released
Simultaneously rotate multiple PlaceableObjects using a provided angle or incremental. This executes a single database operation using Scene#updateEmbeddedDocuments.
Options which configure how multiple objects are rotated
Optionalangle?: numberA target angle of rotation (in degrees) where zero faces "south"
Optionaldelta?: numberAn incremental angle of rotation (in degrees)
Optionalids?: any[]An Array of object IDs to target for rotation
OptionalincludeLocked?: booleanRotate objects whose documents are locked?
Optionalsnap?: numberSnap the resulting angle to a multiple of some increment (in degrees)
An array of objects which were rotated
Select all PlaceableObject instances which fall within a coordinate rectangle.
Optionaloptions: {OptionalcontrolOptions?: objectOptional arguments provided to any called control() method.
Optionalheight?: numberThe height of the selection rectangle.
OptionalreleaseOptions?: objectOptional arguments provided to any called release() method.
Optionalwidth?: numberThe width of the selection rectangle.
Optionalx?: numberThe top-left x-coordinate of the selection rectangle.
Optionaly?: numberThe top-left y-coordinate of the selection rectangle.
Optionalaoptions: { releaseOthers?: boolean } = {}Additional options to configure selection behaviour.
OptionalreleaseOthers?: booleanWhether to release other selected objects.
A boolean for whether the controlled set was changed in the operation.
Assign a set of render flags to all placeables in this layer.
The flags to set
Deconstruct data used in the current layer in preparation to re-draw the canvas
Optionaloptions: object = {}Options which configure how the layer is deconstructed
Undo a change to the objects in this layer This method is typically activated using CTRL+Z while the layer is active
An array of documents which were modified by the undo operation
Update all objects in this layer with a provided transformation. Conditionally filter to only apply to objects which match a certain condition.
An object of data or function to apply to all matched objects
A function which tests whether to target each object
Optionaloptions: object = {}Additional options passed to Document.update
An array of updated data once the operation is complete
Protected_ProtectedCancel mouse wheel rotation.
Protected_ProtectedGet the world-transformed drop position.
Optionaloptions: { center?: boolean } = {}Optionalcenter?: booleanReturn the coordinates of the center of the nearest grid element.
Returns the transformed x, y coordinates, or false if the drag event was outside the canvas.
Protected_ProtectedCreate the shape data from the drag start event.
The pointer event
The initial shape data
Protected_ProtectedHandle double right mouse-click events which originate from the Canvas stage.
The PIXI InteractionEvent which wraps a PointerEvent
Protected_ProtectedHandle a Cycle View keypress while this layer is active.
The cycle-view key press event
Was the event handled?
Protected_ProtectedUndo creation with deletion workflow
An array of documents which were modified by the undo operation
Protected_ProtectedUndo deletion with creation workflow.
An array of documents which were modified by the undo operation
Protected_ProtectedUndo updates with update workflow.
An array of documents which were modified by the undo operation
Protected_ProtectedPrepare the database update that should occur as the result of a mouse wheel rotation.
The update data and options (optional)
Protected_ProtectedRecord a new CRUD event in the history log so that it can be undone later.
Updates without changes are filtered out unless the diff option is set to false.
This function may not be overridden.
The event type
The create/update/delete data
Optionaloptions: object = {}The options of the undo operation
Protected_ProtectedUpdate the mouse wheel rotation preview.
Staticprepare
The Regions Container.