The Sound which manages playback for this AmbientSound effect
A SoundSource object which manages the area of effect for this ambient sound
The area that is affected by this ambient sound.
A control icon for interacting with the object
Retain a reference to the Scene within which this Placeable Object resides
A reference to the Scene embedded Document instance which this object represents
A mouse interaction manager instance which handles mouse workflows related to this object.
Private #baseA sound effect attached to the managed Sound instance.
Private #muffledA sound effect attached to the managed Sound instance when the sound source is muffled.
Private #effectsTrack whether audio effects have been initialized.
Private #muffledIs this AmbientSound currently muffled?
Private #originalThe object that this object is a preview of if this object is a preview.
Private #lastThe bounds that the placeable was added to the quadtree with.
Private #drawingAn internal reference to a Promise in-progress to draw the Placeable Object.
Private #drawnHas this Placeable Object been drawn and is there no drawing in progress?
Static embeddedIdentify the official Document name for this PlaceableObject class
Static RENDER_Is this ambient sound is currently audible based on its hidden state and the darkness level of the Scene?
The bounding box for this PlaceableObject. This is required if the layer uses a Quadtree, otherwise it is optional
A convenience accessor for the sound radius in pixels
The object that this object is a preview of if this object is a preview.
A convenient reference for whether the current User has full control over the document.
The mouse interaction state of this placeable.
The central coordinate pair of the placeable object based on it's own width and height
The id of the corresponding Document which this PlaceableObject represents.
A unique identifier which is used to uniquely identify elements on the canvas related to this object.
The named identified for the source object associated with this PlaceableObject. This differs from the objectId because the sourceId is the same for preview objects as for the original.
Is this placeable object a temporary preview?
Does there exist a temporary preview of this placeable object?
Provide a reference to the CanvasLayer which contains this PlaceableObject.
A Form Application which is used to configure the properties of this Placeable Object or the Document it represents.
An indicator for whether the object is currently controlled
An indicator for whether the object is currently a hover target
Is the HUD display active for this Placeable?
Toggle playback of the sound depending on whether it is audible.
Is the sound audible?
Optional volume: numberThe target playback volume
Optional options: { Additional options which affect sound synchronization
A duration in milliseconds to fade volume transition
Is the sound current muffled?
A promise which resolves once sound playback is synchronized
Clear the display of the existing object.
The cleared object
Compute the field-of-vision for an object, determining its effective line-of-sight and field-of-vision polygons
Optional options: { Options which modify how the audio source is updated
Indicate that this SoundSource has been deleted.
Draw the placeable object into its parent container
Optional options: object = {}Options which may modify the draw and refresh workflow
The drawn object
Internal Execute a partial draw.
The draw function
The drawn object
Refresh all incremental render flags for the PlaceableObject. This method is no longer used by the core software but provided for backwards compatibility.
Optional options: object = {}Options which may modify the refresh workflow
The refreshed object
Assume control over a PlaceableObject, flagging it as controlled and enabling downstream behaviors
Additional options which modify the control request
Release any other controlled objects first
A flag denoting whether control was successful
Clone the placeable object, returning a new object with identical attributes. The returned object is non-interactive, and has no assigned ID. If you plan to use it permanently you should call the create method.
A new object with identical data
Rotate the PlaceableObject to a certain angle of facing
The desired angle of rotation
Snap the angle of rotation to a certain target degree increment
The rotated object
Internal Determine a new angle of rotation for a PlaceableObject either from an explicit angle or from a delta offset.
An object which defines the rotation update parameters
An explicit angle, either this or delta must be provided
A relative angle delta, either this or the angle must be provided
A precision (in degrees) to which the resulting angle should snap. Default is 0.
The new rotation angle for the object
Test whether a user can perform a certain interaction regarding a Placeable Object
The User performing the action
The named action being attempted
Does the User have rights to perform the action?
Protected _createProtected _refreshProtected _refreshProtected _refreshProtected _refreshProtected _getProtected _overlapsProtected _getProtected _onProtected _onProtected _createProtected Create a standard MouseInteractionManager for the PlaceableObject
Protected _canProtected Does the User have permission to control the Placeable Object?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to view details of the Placeable Object?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to create the underlying Document?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to drag this Placeable Object?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to left-click drag this Placeable Object?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to hover on this Placeable Object?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to update the underlying Document?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to delete the underlying Document?
The User performing the action.
The event object.
The returned status.
Protected _onProtected Actions that should be taken for this Placeable Object when a mouseover event occurs. Hover events on PlaceableObject instances allow event propagation by default.
The triggering canvas interaction event
Options which customize event handling
Trigger hover-out behavior on sibling objects
MouseInteractionManager##handlePointerOver
Protected _onProtected _propagateProtected _onProtected _onProtected _onProtected _propagateProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onPrivate #createPrivate #drawDraw the ControlIcon for the AmbientLight
Private #createPrivate #destroyPrivate #commit
An AmbientSound is an implementation of PlaceableObject which represents a dynamic audio source within the Scene.
See