Overlay (RuneLite Client 1.6.33 API)

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

All Implemented Interfaces:

LayoutableRenderableEntity, RenderableEntity

Direct Known Subclasses:

BlastMineRockOverlay, ClueScrollWorldOverlay, FpsOverlay, GroundItemsOverlay, GroundMarkerOverlay, ImplingMinimapOverlay, ImplingsOverlay, ItemStatOverlay, MTAInventoryOverlay, MTASceneOverlay, NpcMinimapOverlay, NpcSceneOverlay, OverlayPanel, PestControlOverlay, PlayerIndicatorsMinimapOverlay, PlayerIndicatorsOverlay, PlayerIndicatorsTileOverlay, PohOverlay, PuzzleSolverOverlay, RoguesDenOverlay, SceneOverlay, ScreenMarkerOverlay, TargetClickboxOverlay, TargetMinimapOverlay, TileIndicatorsOverlay, TitheFarmPlantOverlay, TooltipOverlay, TrapOverlay, WidgetInspectorOverlay, WidgetItemOverlay, WidgetOverlay, WorldMapLocationOverlay, WorldMapOverlay, XpGlobesOverlay
```
public abstract class Overlay
extends 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
`String`	`getName()`	Overlay name, used for saving the overlay, needs to be unique
`boolean`	`onDrag(Overlay other)`	Called when an overlay is dragged onto this, if dragTargetable is true.
`void`	`onMouseOver()`

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.components.LayoutableRenderableEntity
getBounds, setPreferredLocation, setPreferredSize

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

- Constructor Detail
  - Overlay
```
protected Overlay()
```
  - Overlay
```
protected Overlay(Plugin plugin)
```
- Method Detail
  - getName
```
public String getName()
```
    Overlay name, used for saving the overlay, needs to be unique
    
    Returns:
    
    overlay name
  - 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: