Track whether to actively preview ambient sounds with mouse cursor movements
A mapping of ambient audio sources which are active within the rendered Scene
Placeable Layer Objects
Preview Object Placement
Keep track of history so that CTRL+Z can undo changes
Keep track of an object copied with CTRL+C which can be pasted later
A Quadtree which partitions and organizes Walls into quadrants for efficient target identification.
Track whether "highlight all objects" is currently active
Options for this layer instance.
Private #onDarkness change event handler function.
Private #drawingAn internal reference to a Promise in-progress to draw the CanvasLayer.
Private #drawnIs the layer drawn?
Static documentA reference to the named Document type which is contained within this Canvas Layer.
Static SORT_Sort order for placeables belonging to this layer.
Static CREATION_Creation states affected to placeables during their construction.
The name used by hooks to construct their hook string. Note: You should override this getter if hookName should not return the class constructor name.
Obtain a reference to the Collection of embedded Document instances within the currently viewed Scene
If objects on this PlaceablesLayer have a HUD UI, provide a reference to its instance
A convenience method for accessing the placeable object instances contained in this layer
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.
Track the PlaceableObject on this layer which is currently hovered upon.
Is this layer currently active
The canonical name of the CanvasLayer is the name of the constructor that is the immediate child of the defined baseClass for the layer type.
canvas.lighting.name -> "LightingLayer"
Static layerConfiguration options for the PlaceablesLayer.
Static placeableObtain a reference to the PlaceableObject class definition which represents the Document type in this layer.
Static instanceReturn a reference to the active instance of this canvas layer
Play a one-shot Sound originating from a predefined point on the canvas. The sound plays locally for the current client only. To play a sound for all connected clients use SoundsLayer#emitAtPosition.
The sound source path to play
The canvas coordinates from which the sound originates
The radius of effect in distance units
Additional options which configure playback
The maximum volume at which the effect should be played
Should volume be attenuated by distance?
Should the sound be constrained by walls?
Should the sound always be played for GM users regardless of actively controlled tokens?
A base sound effect to apply to playback
A muffled sound effect to apply to playback, a sound may only be muffled if it is not constrained by walls
Additional data passed to the SoundSource constructor
Additional options passed to Sound#play
A Promise which resolves to the played Sound, or null
const src = "modules/my-module/sounds/spring-trap.ogg";
const origin = {x: 5200, y: 3700}; // The origin point for the sound
const radius = 30; // Audible in a 30-foot radius
await canvas.sounds.playAtPosition(src, origin, radius);
const src = "modules/my-module/sounds/spells-sprite.ogg";
const origin = token.center; // The origin point for the sound
const radius = 60; // Audible in a 60-foot radius
await canvas.sounds.playAtPosition(src, origin, radius, {
walls: false, // Not constrained by walls with a lowpass muffled effect
muffledEffect: {type: "lowpass", intensity: 6},
sourceData: {
angle: 120, // Sound emitted at a limited angle
rotation: 270 // Configure the direction of sound emission
}
playbackOptions: {
loopStart: 12, // Audio sprite timing
loopEnd: 16,
fade: 300, // Fade-in 300ms
onended: () => console.log("Do something after the spell sound has played")
}
});
Handle PlaylistSound document drop data.
The drag drop event
The dropped transfer data.
Iterates over placeable objects that are eligible for control/select.
A placeable object
Draw a single placeable object
The Document instance used to create the placeable object
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
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
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
A target angle of rotation (in degrees) where zero faces "south"
An incremental angle of rotation (in degrees)
Snap the resulting angle to a multiple of some increment (in degrees)
An Array of object IDs to target for rotation
Rotate objects whose documents are locked?
An array of objects which were rotated
An error if an explicitly provided id is not valid
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
Horizontal movement direction
Vertical movement direction
Rotate the placeable to direction instead of moving
An Array of object IDs to target for movement. The default is the IDs of controlled objects.
Move objects whose documents are locked?
An array of objects which were moved during the operation
An error if an explicitly provided id is not valid
Internal An 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
An error if any explicitly requested ID is not valid
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
Copy currently controlled PlaceableObjects to a temporary Array, ready to paste back into the scene later
The Array of copied PlaceableObject instances
Paste currently copied PlaceableObjects back to the layer by creating new copies
The destination position for the copied data.
Optional options: { Options which modify the paste operation
Paste data in a hidden state, if applicable. Default is false.
Snap the resulting objects to the grid. Default is true.
An Array of created Document instances
Select all PlaceableObject instances which fall within a coordinate rectangle.
Optional options: { The top-left x-coordinate of the selection rectangle.
The top-left y-coordinate of the selection rectangle.
The width of the selection rectangle.
The height of the selection rectangle.
Optional arguments provided to any called release() method.
Optional arguments provided to any called control() method.
Optional aoptions: { Additional options to configure selection behaviour.
Whether to release other selected objects.
A boolean for whether the controlled set was changed in the 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
Optional options: object = {}Additional options passed to Document.update
An array of updated data once the operation is complete
Internal Create 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.
Optional options: { Options which configure preview creation
Render the preview object config sheet?
The offset-top position where the sheet should be rendered
The offset-left position where the sheet should be rendered
The created preview object
Activate the InteractionLayer, deactivating other layers and marking this layer's children as interactive.
Optional options: { Options which configure layer activation
A specific tool in the control palette to set as active
The layer instance, now activated
Deactivate the InteractionLayer, removing interactivity from its children.
The layer instance, now inactive
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.
Optional options: object = {}Options which configure how the layer is drawn
Deconstruct data used in the current layer in preparation to re-draw the canvas
Optional options: object = {}Options which configure how the layer is deconstructed
Protected _syncProtected Sync the playing state and volume of all AmbientSound objects based on the position of listener points
Locations of listeners which have the capability to hear
Optional options: objectAdditional options forwarded to AmbientSound synchronization
Protected _configureProtected Configure playback by assigning the muffled state and final playback volume for the sound. This method should mutate the config object by assigning the volume and muffled properties.
Protected _pasteProtected Get the data of the copied object pasted at the position given by the offset. Called by PlaceablesLayer#pasteObjects for each copied object.
The copied object that is pasted
The offset relative from the current position to the destination
Optional options: { Options of PlaceablesLayer#pasteObjects
Paste in a hidden state, if applicable. Default is false.
Snap to the grid. Default is true.
The update data
Protected _canvasProtected Get the world-transformed drop position.
Optional options: { Return 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 _on
This Canvas Layer provides a container for AmbientSound objects.