Members
(static) defaultOptions
layer :PlaceablesLayer
Convenience access for the canvas layer which this HUD modifies
Type:
object :PlaceableObject
Reference a PlaceableObject this HUD is currently bound to
Type:
Methods
(protected) _onClickControl(event)
Handle mouse clicks to control a HUD control button
Parameters:
Name | Type | Description |
---|---|---|
event |
PointerEvent | The originating click event |
(async, protected) _onSort(up, event) → {Promise}
Handle sorting the z-order of the object
Parameters:
Name | Type | Description |
---|---|---|
up |
boolean | Move the object upwards in the vertical stack? |
event |
PointerEvent | The originating mouse click event |
Returns:
- Type
- Promise
(async) _render()
activateListeners()
bind(object)
Bind the HUD to a new PlaceableObject and display it
Parameters:
Name | Type | Description |
---|---|---|
object |
PlaceableObject | A PlaceableObject instance to which the HUD should be bound |
clear()
Clear the HUD by fading out it's active HTML and recording the new display state