Module: wcGhost

Source:

Methods


<static> function constructor(rect, mouse, docker)

Parameters:
Name Type Description
rect module:wcDocker~Rect A rectangle area to begin the ghost highlighting.
mouse module:wcDocker~Coordinate The mouse position.
docker module:wcDocker The docker object.
Source:

function anchor( [mouse] [, anchor])

Get, or Sets the ghost's anchor.

Parameters:
Name Type Argument Description
mouse module:wcDocker~Coordinate <optional>
If supplied with the anchor, .
anchor module:wcDocker~Anchor <optional>
If supplied, assigns a new anchor.
Source:

function destroy()

Destroys the instance of the ghost.

Source:

function rect() -> module:wcDocker~AnchorRect

Retrieves the rectangle area of the ghost's anchor.

Source:
Returns:
- The rectangle area of the anchor.
Type
module:wcDocker~AnchorRect

function update(position [, disableFloating])

Updates the ghost based on the given screen position.

Parameters:
Name Type Argument Description
position module:wcDocker~Coordinate The mouse position.
disableFloating Boolean <optional>
If true, the ghost will not float.
Source: