Class OverlaySet

java.lang.Object
privbot.ui.overlay.OverlaySet
All Implemented Interfaces:
AutoCloseable

public final class OverlaySet extends Object implements AutoCloseable
The overlays a plugin registered, as one handle: setVisible(boolean) adds or removes them all, close() removes them for shutDown().
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Removes every overlay from the manager; call it in shutDown().
    boolean
    Whether the overlays are currently registered with the manager.
    List<net.runelite.client.ui.overlay.Overlay>
    The overlays in this set, in install order (unmodifiable).
    void
    setVisible(boolean show)
    Add every overlay to the manager (true) or remove them (false); idempotent.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Method Details

    • overlays

      public List<net.runelite.client.ui.overlay.Overlay> overlays()
      The overlays in this set, in install order (unmodifiable).
    • isVisible

      public boolean isVisible()
      Whether the overlays are currently registered with the manager.
    • setVisible

      public void setVisible(boolean show)
      Add every overlay to the manager (true) or remove them (false); idempotent.
    • close

      public void close()
      Removes every overlay from the manager; call it in shutDown(). Safe to call twice.
      Specified by:
      close in interface AutoCloseable