java.lang.Object
- net.runelite.client.ui.overlay.Overlay

All Implemented Interfaces:

LayoutableRenderableEntity, RenderableEntity

Direct Known Subclasses:

BlastMineRockOverlay, ClueScrollWorldOverlay, FpsOverlay, GroundItemsOverlay, GroundMarkerOverlay, ItemStatOverlay, MTASceneOverlay, OverlayPanel, PestControlOverlay, PlayerIndicatorsMinimapOverlay, PlayerIndicatorsOverlay, PlayerIndicatorsTileOverlay, PohOverlay, PuzzleSolverOverlay, SceneOverlay, ScreenMarkerOverlay, TileIndicatorsOverlay, TitheFarmPlantOverlay, TooltipOverlay, TrapOverlay, WidgetInspectorOverlay, WidgetItemOverlay, WidgetOverlay, WorldMapLocationOverlay, WorldMapOverlay, XpGlobesOverlay
```
public abstract class Overlay
extends java.lang.Object
implements LayoutableRenderableEntity
```

Constructor Summary

Constructors
Modifier Constructor Description

protected Overlay()

protected Overlay(Plugin plugin)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`drawAfterInterface(int interfaceId)`	Configure to draw this overlay after the given interface is drawn.
`protected void`	`drawAfterLayer(int groupId, int childId)`	Configure to draw this overlay after the given layer is drawn.
`protected void`	`drawAfterLayer(net.runelite.api.widgets.WidgetInfo layer)`	Configure to draw this overlay after the given layer is drawn.
`java.awt.Rectangle`	`getBounds()`
`java.util.List<java.lang.Integer>`	`getDrawHooks()`
`OverlayLayer`	`getLayer()`
`java.util.List<OverlayMenuEntry>`	`getMenuEntries()`
`int`	`getMinimumSize()`
`java.lang.String`	`getName()`	Overlay name, used for saving the overlay, needs to be unique
`java.awt.Rectangle`	`getParentBounds()`	Get the parent bounds for overlay dragging.
`Plugin`	`getPlugin()`
`OverlayPosition`	`getPosition()`
`java.awt.Point`	`getPreferredLocation()`
`OverlayPosition`	`getPreferredPosition()`
`java.awt.Dimension`	`getPreferredSize()`
`OverlayPriority`	`getPriority()`
`boolean`	`isDragTargetable()`	Whether this overlay can be dragged onto other overlays & have other overlays dragged onto it.
`boolean`	`isMovable()`	Whether this overlay can be moved with alt
`boolean`	`isResettable()`
`boolean`	`isResizable()`
`boolean`	`isSnappable()`	Whether this overlay can be moved to a snap corner and have its preferredPosition changed
`boolean`	`onDrag(Overlay other)`	Called when an overlay is dragged onto this, if dragTargetable is true.
`void`	`onMouseOver()`
`void`	`revalidate()`
`void`	`setBounds(java.awt.Rectangle bounds)`
`protected void`	`setDragTargetable(boolean dragTargetable)`	Whether this overlay can be dragged onto other overlays & have other overlays dragged onto it.
`void`	`setLayer(OverlayLayer layer)`
`void`	`setMinimumSize(int minimumSize)`
`protected void`	`setMovable(boolean movable)`	Whether this overlay can be moved with alt
`void`	`setPosition(OverlayPosition position)`
`void`	`setPreferredLocation(java.awt.Point preferredLocation)`
`void`	`setPreferredPosition(OverlayPosition preferredPosition)`
`void`	`setPreferredSize(java.awt.Dimension preferredSize)`
`void`	`setPriority(OverlayPriority priority)`
`void`	`setResettable(boolean resettable)`
`void`	`setResizable(boolean resizable)`
`protected void`	`setSnappable(boolean snappable)`	Whether this overlay can be moved to a snap corner and have its preferredPosition changed

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.runelite.client.ui.overlay.RenderableEntity
render

- Constructor Detail
  - Overlay
```
protected Overlay()
```
  - Overlay
```
protected Overlay(@Nullable
                  Plugin plugin)
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Overlay name, used for saving the overlay, needs to be unique
    
    Returns:
    
    overlay name
  - drawAfterInterface
```
protected void drawAfterInterface(int interfaceId)
```
    Configure to draw this overlay after the given interface is drawn. Except in rare circumstances, you probably also want to setLayer(OverlayLayer) to OverlayLayer.MANUAL to avoid the overlay being drawn a 2nd time during the default OverlayLayer.UNDER_WIDGETS pass.
    
    Parameters:
    
    interfaceId - The interface id
    
    See Also:
    
    WidgetID
  - drawAfterLayer
```
protected void drawAfterLayer(int groupId,
                              int childId)
```
    Configure to draw this overlay after the given layer is drawn. Except in rare circumstances, you probably also want to setLayer(OverlayLayer) to OverlayLayer.MANUAL to avoid the overlay being drawn a 2nd time during the default OverlayLayer.UNDER_WIDGETS pass. The layer must be a widget of WidgetType WidgetType.LAYER
    
    Parameters:
    
    groupId - The widget group id
    
    childId - The widget child id
    
    See Also:
    
    WidgetID
  - drawAfterLayer
```
protected void drawAfterLayer(net.runelite.api.widgets.WidgetInfo layer)
```
    Configure to draw this overlay after the given layer is drawn. Except in rare circumstances, you probably also want to setLayer(OverlayLayer) to OverlayLayer.MANUAL to avoid the overlay being drawn a 2nd time during the default OverlayLayer.UNDER_WIDGETS pass. The layer must be a widget of WidgetType WidgetType.LAYER
    
    Parameters:
    
    layer - The layer
    
    See Also:
    
    WidgetInfo
  - onMouseOver
```
public void onMouseOver()
```
  - onDrag
```
public boolean onDrag(Overlay other)
```
    Called when an overlay is dragged onto this, if dragTargetable is true. Return true to consume the mouse event and prevent the other overlay from being moved
    
    Parameters:
    
    other - the overlay being dragged
    
    Returns:
  - getParentBounds
```
@Nullable
public java.awt.Rectangle getParentBounds()
```
    Get the parent bounds for overlay dragging. The overlay will not be allowed to be moved outside of the parent bounds.
    
    Returns:
  - revalidate
```
public void revalidate()
```
  - setPosition
```
public void setPosition(OverlayPosition position)
```
  - getPlugin
```
@Nullable
public Plugin getPlugin()
```
  - getPreferredLocation
```
public java.awt.Point getPreferredLocation()
```
  - getPreferredSize
```
public java.awt.Dimension getPreferredSize()
```
  - getPreferredPosition
```
public OverlayPosition getPreferredPosition()
```
  - getBounds
```
public java.awt.Rectangle getBounds()
```
    Specified by:
    
    getBounds in interface LayoutableRenderableEntity
  - getPosition
```
public OverlayPosition getPosition()
```
  - getPriority
```
public OverlayPriority getPriority()
```
  - getLayer
```
public OverlayLayer getLayer()
```
  - getDrawHooks
```
public java.util.List<java.lang.Integer> getDrawHooks()
```
  - getMenuEntries
```
public java.util.List<OverlayMenuEntry> getMenuEntries()
```
  - isResizable
```
public boolean isResizable()
```
  - getMinimumSize
```
public int getMinimumSize()
```
  - isResettable
```
public boolean isResettable()
```
  - isDragTargetable
```
public boolean isDragTargetable()
```
    Whether this overlay can be dragged onto other overlays & have other overlays dragged onto it.
  - isMovable
```
public boolean isMovable()
```
    Whether this overlay can be moved with alt
  - isSnappable
```
public boolean isSnappable()
```
    Whether this overlay can be moved to a snap corner and have its preferredPosition changed
  - setPreferredLocation
```
public void setPreferredLocation(java.awt.Point preferredLocation)
```
    Specified by:
    
    setPreferredLocation in interface LayoutableRenderableEntity
  - setPreferredSize
```
public void setPreferredSize(java.awt.Dimension preferredSize)
```
    Specified by:
    
    setPreferredSize in interface LayoutableRenderableEntity
  - setPreferredPosition
```
public void setPreferredPosition(OverlayPosition preferredPosition)
```
  - setBounds
```
public void setBounds(java.awt.Rectangle bounds)
```
  - setPriority
```
public void setPriority(OverlayPriority priority)
```
  - setLayer
```
public void setLayer(OverlayLayer layer)
```
  - setResizable
```
public void setResizable(boolean resizable)
```
  - setMinimumSize
```
public void setMinimumSize(int minimumSize)
```
  - setResettable
```
public void setResettable(boolean resettable)
```
  - setDragTargetable
```
protected void setDragTargetable(boolean dragTargetable)
```
    Whether this overlay can be dragged onto other overlays & have other overlays dragged onto it.
  - setMovable
```
protected void setMovable(boolean movable)
```
    Whether this overlay can be moved with alt
  - setSnappable
```
protected void setSnappable(boolean snappable)
```
    Whether this overlay can be moved to a snap corner and have its preferredPosition changed

Constructors
Modifier	Constructor	Description
`protected`	`Overlay()`
`protected`	`Overlay(Plugin plugin)`

Class Overlay

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.runelite.client.ui.overlay.RenderableEntity

Constructor Detail

Overlay

Overlay

Method Detail

getName

drawAfterInterface

drawAfterLayer

drawAfterLayer

onMouseOver

onDrag

getParentBounds

revalidate

setPosition

getPlugin

getPreferredLocation

getPreferredSize

getPreferredPosition

getBounds

getPosition

getPriority

getLayer

getDrawHooks

getMenuEntries

isResizable

getMinimumSize

isResettable

isDragTargetable

isMovable

isSnappable

setPreferredLocation

setPreferredSize

setPreferredPosition

setBounds

setPriority

setLayer

setResizable

setMinimumSize

setResettable

setDragTargetable

setMovable

setSnappable