A reference to the PointSource object which defines this light source area of effect
A reference to the ControlIcon used to configure this light
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.
Know if a placeable is in the hover-in state.
Passthrough certain drag operations on locked objects.
Identify the official Document name for this PlaceableObject class
A convenience accessor to the LightData configuration object
Test whether a specific AmbientLight source provides global illumination
The maximum radius in pixels of the light field
Get the pixel radius of dim light emitted by this light source
Get the pixel radius of bright light emitted by this light source
Is this Ambient Light currently visible? By default, true only if the source actively emits light.
Does this Ambient Light actively emit light given its properties and the current darkness level of the Scene?
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?
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
Refresh the display of the ControlIcon for this AmbientLight source
Update the LightSource associated with this AmbientLight object.
Options which modify how the source is updated
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 updated with new data
Define additional steps taken when an existing placeable object of this type is deleted
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 configure the Placeable Object?
The User performing the action.
The event object.
The returned status.
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 mouse-move operation.
The triggering canvas interaction event
Callback actions which occur on a mouse-move operation.
The triggering mouse click event
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?
Clear the display of the existing object.
The cleared 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
Draw the placeable object into its parent container
The drawn object
Refresh the current display state of the Placeable Object
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
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.
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
Actions that should be taken for this Placeable Object when a mouseover event occurs
The triggering canvas interaction event
Options which customize event handling
Actions that should be taken for this Placeable Object when a mouseout event occurs
The triggering canvas interaction event
Callback actions which occur on a single left-click event to assume control of the object
The triggering canvas interaction event
Callback actions which occur on a double left-click event to activate
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
Callback actions which occur on a mouse-move operation.
The triggering canvas interaction event
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 view details of 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 hover on 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.
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
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 action which occurs on a long press.
The triggering canvas interaction event
The local canvas coordinates of the mousepress.
Draw the ControlIcon for the AmbientLight
An AmbientLight is an implementation of PlaceableObject which represents a dynamic light source within the Scene.
AmbientLightDocument
LightingLayer