ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

overlay: add drawAfterLayer that accepts ids for plugins, and javadoc

Browse Source
This commit is contained in:
Adam
2022-04-08 21:48:37 -04:00
parent d12bca1a8f
commit f1e7829771
1 changed files with 37 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
runelite-client/src/main/java/net/runelite/client/ui/overlay/Overlay.java
View File

@@ -24,6 +24,7 @@
*/ */
package net.runelite.client.ui.overlay; package net.runelite.client.ui.overlay;
import com.google.common.base.Preconditions;
import java.awt.Dimension; import java.awt.Dimension;
import java.awt.Point; import java.awt.Point;
import java.awt.Rectangle; import java.awt.Rectangle;
@@ -83,11 +84,47 @@ public abstract class Overlay implements LayoutableRenderableEntity
return this.getClass().getSimpleName(); return this.getClass().getSimpleName();
} }
/**
* Configure to draw this overlay after the given interface is drawn. Except
* in rare circumstances, you probably also want to {@link #setLayer(OverlayLayer)} to
* {@link OverlayLayer#MANUAL} to avoid the overlay being drawn a 2nd time during the
* default {@link OverlayLayer#UNDER_WIDGETS} pass.
* @param interfaceId The interface id
* @see net.runelite.api.widgets.WidgetID
*/
protected void drawAfterInterface(int interfaceId) protected void drawAfterInterface(int interfaceId)
{ {
drawHooks.add(interfaceId << 16 | 0xffff); drawHooks.add(interfaceId << 16 | 0xffff);
} }
/**
* Configure to draw this overlay after the given layer is drawn. Except
* in rare circumstances, you probably also want to {@link #setLayer(OverlayLayer)} to
* {@link OverlayLayer#MANUAL} to avoid the overlay being drawn a 2nd time during the
* default {@link OverlayLayer#UNDER_WIDGETS} pass.
*
* The layer must be a widget of {@link net.runelite.api.widgets.WidgetType} {@link net.runelite.api.widgets.WidgetType#LAYER}
* @param groupId The widget group id
* @param childId The widget child id
* @see net.runelite.api.widgets.WidgetID
*/
protected void drawAfterLayer(int groupId, int childId)
{
Preconditions.checkArgument(groupId >= 0 && groupId <= 0xffff, "groupId outside of valid range");
Preconditions.checkArgument(childId >= 0 && childId <= 0xffff, "childId outside of valid range");
drawHooks.add(groupId << 16 | childId);
}
/**
* Configure to draw this overlay after the given layer is drawn. Except
* in rare circumstances, you probably also want to {@link #setLayer(OverlayLayer)} to
* {@link OverlayLayer#MANUAL} to avoid the overlay being drawn a 2nd time during the
* default {@link OverlayLayer#UNDER_WIDGETS} pass.
*
* The layer must be a widget of {@link net.runelite.api.widgets.WidgetType} {@link net.runelite.api.widgets.WidgetType#LAYER}
* @param layer The layer
* @see WidgetInfo
*/
protected void drawAfterLayer(WidgetInfo layer) protected void drawAfterLayer(WidgetInfo layer)
{ {
drawHooks.add(layer.getId()); drawHooks.add(layer.getId());