A reference the Door Control icon associated with this Wall, if any
The line segment that represents the Wall.
The endpoints of the Wall line segment.
The icon that indicates the direction of the Wall.
A Graphics object used to highlight this wall segment. Only used when the wall is controlled.
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 control icon for interacting with the object
A mouse interaction manager instance which handles mouse workflows related to this object.
Private #priorCache the prior door state so that we can identify changes in the door state.
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_A convenience reference to the coordinates Array for the Wall endpoints, [x0,y0,x1,y1].
The Edge instance which represents this Wall. The Edge is re-created when data for the Wall changes.
The bounding box for this PlaceableObject. This is required if the layer uses a Quadtree, otherwise it is optional
A boolean for whether this wall contains a door
A boolean for whether the wall contains an open door
Return the coordinates [x,y] at the midpoint of the wall segment
The central coordinate pair of the placeable object based on it's own width and height
Get the direction of effect for a directional Wall
Customize the audible radius of sounds emitted by this wall, for example when a door opens or closes.
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 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?
Draw a control icon that is used to manipulate the door's open/closed state
Assume control over a PlaceableObject, flagging it as controlled and enabling downstream behaviors
Additional options which modify the control request
A flag denoting whether control was successful
Test whether the Wall direction lies between two provided angles This test is used for collision and vision checks against one-directional walls
The lower-bound limiting angle in radians
The upper-bound limiting angle in radians
A simple test for whether a Ray can intersect a directional wall
The ray to test
Can an intersection occur?
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
MouseInteractionManager##handlePointerOver
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
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 _refreshProtected _refreshProtected _refreshProtected _refreshProtected _refreshProtected _getProtected _playProtected _getProtected _onProtected _onProtected _createProtected Create a standard MouseInteractionManager for the PlaceableObject
Protected _canHUDProtected Can the User access the HUD for this Placeable Object?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to configure 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 _propagateProtected _onProtected _propagateProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onPrivate #createPrivate #drawPrivate #getPrivate #onPrivate #commitStatic Private #get
A Wall is an implementation of PlaceableObject which represents a physical or visual barrier within the Scene. Walls are used to restrict Token movement or visibility as well as to define the areas of effect for ambient lights and sounds.
See