The associated JournalEntry which is referenced by this Note
The specific JournalEntryPage within the associated JournalEntry referenced by this Note.
The text label used to annotate this Note
The Map Note icon size
Determine whether the Note is visible to the current user based on their perspective of the Scene. Visibility depends on permission to the underlying journal entry, as well as the perspective of controlled Tokens. If Token Vision is required, the user must have a token with vision over the note to see it.
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?
The field-of-vision polygon for the object, if it has been computed
Provide a reference to the CanvasLayer which contains this PlaceableObject.
The line-of-sight polygon for the object, if it has been computed
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
An indicator for whether the object is currently a hover target
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
True if the event was handled, otherwise false
Callback actions which occur on a double left-click event to activate
The triggering canvas interaction event
Clear the display of the existing object.
The cleared object
Draw the placeable object into its parent container
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.
The refreshed object
Update the quadtree.
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
Release control over a PlaceableObject, removing it from the controlled set
Options which modify the releasing workflow
A Boolean flag confirming the object was released.
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
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
The new rotation angle for the object
Obtain a shifted position for the Placeable Object
The number of grid units to shift along the X-axis
The number of grid units to shift along the Y-axis
The shifted target coordinates
Activate interactivity for the Placeable 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?
Draw the ControlIcon for the Map Note. This method replaces any prior controlIcon with the new one.
Draw the map note Tooltip as a Text object. This method replaces any prior text with the new one.
Define a PIXI TextStyle object which is used for the tooltip displayed for this Note
Refresh the visibility.
The inner _destroy method which may optionally be defined by each PlaceableObject subclass.
Get the target opacity that should be used for a Placeable Object depending on its preview state.
Register pending canvas operations which should occur after a new PlaceableObject of this type is created
Define additional steps taken when an existing placeable object of this type is deleted
Additional events which trigger once control of the object is established
Optional parameters which apply for specific implementations
Additional events which trigger once control of the object is released
Options which modify the releasing workflow
Create a standard MouseInteractionManager for the PlaceableObject
Can the User access the HUD for this Placeable Object?
The User performing the action.
The event object.
The returned status.
Does the User have permission to control the Placeable Object?
The User performing the action.
The event object.
The returned status.
Does the User have permission to create the underlying Document?
The User performing the action.
The event object.
The returned status.
Does the User have permission to drag this Placeable Object?
The User performing the action.
The event object.
The returned status.
Does the User have permission to update the underlying Document?
The User performing the action.
The event object.
The returned status.
Does the User have permission to delete the underlying Document?
The User performing the action.
The event object.
The returned status.
Actions that should be taken for this Placeable Object when a mouseout event occurs
The triggering canvas interaction event
True if the event was handled, otherwise false
Should the placeable propagate left click downstream?
Callback actions which occur on a single left-click event to assume control of the object
The triggering canvas interaction event
Should the placeable propagate right click downstream?
Callback actions which occur on a single right-click event to configure properties of the object
The triggering canvas interaction event
Callback actions which occur on a double right-click event to configure properties of the object
The triggering canvas interaction event
Callback actions which occur when a mouse-drag action is first begun.
The triggering canvas interaction event
Begin a drag operation from the perspective of the preview clone. Modify the appearance of both the clone (this) and the original (_original) object.
Conclude a drag operation from the perspective of the preview clone. Modify the appearance of both the clone (this) and the original (_original) object.
Callback actions which occur on a mouse-move operation.
The triggering canvas interaction event
Callback actions which occur on a mouse-move operation.
The triggering canvas interaction event
Callback actions which occur on a mouse-move operation.
The triggering mouse click event
Callback action which occurs on a long press.
The triggering canvas interaction event
The local canvas coordinates of the mousepress.
Refresh the state of the Note. Called the Note enters a different interaction state.
Refresh the position of the Note. Called with the coordinates change.
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
Track the field of vision for the placeable object. This is necessary to determine whether a player has line-of-sight towards a placeable object or vice-versa
A mouse interaction manager instance which handles mouse workflows related to this object.
Passthrough certain drag operations on locked objects.
Know if a placeable is in the hover-in state.
The bounds that the placeable was added to the quadtree with.
An internal reference to a Promise in-progress to draw the Placeable Object.
Has this Placeable Object been drawn and is there no drawing in progress?
Identify the official Document name for this PlaceableObject class
A Note is an implementation of PlaceableObject which represents an annotated location within the Scene. Each Note links to a JournalEntry document and represents its location on the map.
NoteDocument
NotesLayer