OverlayPanel
An overlay that draws a box of lines over the game.
Abstract classRuneLiteRuneLite docs
public abstract class OverlayPanel extends OverlayExtend it, pass your plugin to super(plugin) and pick a place with setPosition. In render, add components to panelComponent (TitleComponent, LineComponent, ImageComponent, ProgressBarComponent) and return super.render(graphics). The client calls render every frame on the game thread, so read state there; do not wait in it.
Add the overlay with OverlayManager.add in startUp() and remove it with OverlayManager.remove in shutDown(). To draw on tiles and NPCs instead, extend Overlay and use OverlayUtil.
Example
package example;
import com.tonic.api.widgets.InventoryAPI;
import java.awt.Dimension;
import java.awt.Graphics2D;
import javax.inject.Inject;
import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor;
import net.runelite.client.ui.overlay.OverlayManager;
import net.runelite.client.ui.overlay.OverlayPanel;
import net.runelite.client.ui.overlay.OverlayPosition;
import net.runelite.client.ui.overlay.components.LineComponent;
import net.runelite.client.ui.overlay.components.TitleComponent;
@PluginDescriptor(name = "Example Overlay")
public class ExamplePlugin extends Plugin {
@Inject private OverlayManager overlayManager;
@Inject private TripOverlay overlay;
@Override
protected void startUp() {
overlayManager.add(overlay);
}
@Override
protected void shutDown() {
overlayManager.remove(overlay);
}
}
class TripOverlay extends OverlayPanel {
@Inject
TripOverlay(ExamplePlugin plugin) {
super(plugin);
setPosition(OverlayPosition.TOP_LEFT);
}
@Override
public Dimension render(Graphics2D graphics) {
panelComponent.getChildren().add(TitleComponent.builder().text("Trip").build());
panelComponent.getChildren().add(LineComponent.builder()
.left("Free slots").right(Integer.toString(InventoryAPI.getEmptySlots())).build());
return super.render(graphics);
}
}Constants
PRIORITY_DEFAULT, PRIORITY_HIGH, PRIORITY_HIGHEST, PRIORITY_LOW, PRIORITY_MED, panelComponent
Also allowed
These work as in the RuneLite docs.
addMenuEntry, clone, drawAfterInterface, drawAfterLayer, equals, getBounds, getDrawHooks, getLayer, getMenuEntries, getMinimumSize, getName, getPanelComponent, getParentBounds, getPlugin, getPosition, getPreferredColor, getPreferredLocation, getPreferredPosition, getPreferredSize, getPriority, hashCode, isClearChildren, isDragTargetable, isDynamicFont, isMovable, isResettable, isResizable, isSnappable, new OverlayPanel, onDrag, onMouseOver, removeMenuEntry, render, revalidate, setBounds, setClearChildren, setDragTargetable, setDynamicFont, setLayer, setMinimumSize, setMovable, setPosition, setPreferredColor, setPreferredLocation, setPreferredPosition, setPreferredSize, setPriority, setResettable, setResizable, setSnappable, toString