Package net.runelite.client.ui.overlay

Class Overlay

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

Modifier and Type	Method	Description
protected void	drawAfterInterface(int interfaceId)
protected void	drawAfterLayer(net.runelite.api.widgets.WidgetInfo layer)
Rectangle	getBounds()
List<Integer>	getDrawHooks()
OverlayLayer	getLayer()
List<OverlayMenuEntry>	getMenuEntries()
int	getMinimumSize()
String	getName()	Overlay name, used for saving the overlay, needs to be unique
Rectangle	getParentBounds()	Get the parent bounds for overlay dragging.
Plugin	getPlugin()
OverlayPosition	getPosition()
Point	getPreferredLocation()
OverlayPosition	getPreferredPosition()
Dimension	getPreferredSize()
OverlayPriority	getPriority()
boolean	isDragTargetable()	Whether this overlay can be dragged onto other overlays & have other overlays dragged onto it.
boolean	isResettable()
boolean	isResizable()
boolean	onDrag(Overlay other)	Called when an overlay is dragged onto this, if dragTargetable is true.
void	onMouseOver()
void	setBounds(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)
void	setPosition(OverlayPosition position)
void	setPreferredLocation(Point preferredLocation)
void	setPreferredPosition(OverlayPosition preferredPosition)
void	setPreferredSize(Dimension preferredSize)
void	setPriority(OverlayPriority priority)
void	setResettable(boolean resettable)
void	setResizable(boolean resizable)

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(Plugin plugin)

Method Detail

getName

public String getName()

Overlay name, used for saving the overlay, needs to be unique

Returns:

overlay name

drawAfterInterface

protected void drawAfterInterface(int interfaceId)

drawAfterLayer

protected void drawAfterLayer(net.runelite.api.widgets.WidgetInfo layer)

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 Rectangle getParentBounds()

Get the parent bounds for overlay dragging. The overlay will not be allowed to be moved outside of the parent bounds.

Returns:

getPlugin

@Nullable
public Plugin getPlugin()

getPreferredLocation

public Point getPreferredLocation()

getPreferredSize

public Dimension getPreferredSize()

getPreferredPosition

public OverlayPosition getPreferredPosition()

getBounds

public Rectangle getBounds()

Specified by:

getBounds in interface LayoutableRenderableEntity

getPosition

public OverlayPosition getPosition()

getPriority

public OverlayPriority getPriority()

getLayer

public OverlayLayer getLayer()

getDrawHooks

public List<Integer> getDrawHooks()

getMenuEntries

public 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.

setPreferredLocation

public void setPreferredLocation(Point preferredLocation)

Specified by:

setPreferredLocation in interface LayoutableRenderableEntity

setPreferredSize

public void setPreferredSize(Dimension preferredSize)

Specified by:

setPreferredSize in interface LayoutableRenderableEntity

setPreferredPosition

public void setPreferredPosition(OverlayPosition preferredPosition)

setBounds

public void setBounds(Rectangle bounds)

setPosition

public void setPosition(OverlayPosition position)

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.