Enum Capability

java.lang.Object
java.lang.Enum<Capability>
privbot.api.Capability
All Implemented Interfaces:
Serializable, Comparable<Capability>, java.lang.constant.Constable

public enum Capability extends Enum<Capability>
One thing a plugin can ask the unified API to read or do. One constant per row of the SDK capability matrix, split into read and act where the two differ on some server.

Ask ctx.capabilities.support(Capability.BANK_WITHDRAW) before relying on a verb on a server you have not tested. The answers come from a capability matrix generated from the Shared API Tester bench results and an evidence-backed override table; the SDK docs, Compatibility, show the same data as a page.

New constants may be added in a minor API version. Never switch exhaustively over this enum.

  • Enum Constant Details

    • INVENTORY_READ

      public static final Capability INVENTORY_READ
    • INVENTORY_INTERACT

      public static final Capability INVENTORY_INTERACT
    • EQUIPMENT_READ

      public static final Capability EQUIPMENT_READ
    • EQUIPMENT_INTERACT

      public static final Capability EQUIPMENT_INTERACT
    • BANK_READ

      public static final Capability BANK_READ
    • BANK_OPEN

      public static final Capability BANK_OPEN
    • BANK_WITHDRAW

      public static final Capability BANK_WITHDRAW
    • BANK_DEPOSIT

      public static final Capability BANK_DEPOSIT
    • BANK_CLOSE

      public static final Capability BANK_CLOSE
    • NPC_READ

      public static final Capability NPC_READ
    • NPC_INTERACT

      public static final Capability NPC_INTERACT
    • NPC_ATTACK

      public static final Capability NPC_ATTACK
    • OBJECT_READ

      public static final Capability OBJECT_READ
    • OBJECT_INTERACT

      public static final Capability OBJECT_INTERACT
    • GROUND_ITEM_READ

      public static final Capability GROUND_ITEM_READ
    • GROUND_ITEM_TAKE

      public static final Capability GROUND_ITEM_TAKE
    • PLAYER_READ

      public static final Capability PLAYER_READ
    • LOCAL_PLAYER_READ

      public static final Capability LOCAL_PLAYER_READ
    • GAME_STATE_READ

      public static final Capability GAME_STATE_READ
    • RUN_TOGGLE

      public static final Capability RUN_TOGGLE
    • WALK

      public static final Capability WALK
      Walking to a tile that is on screen.
    • WALK_OFFSCREEN

      public static final Capability WALK_OFFSCREEN
      Walking to a tile that is not on screen in one call.
    • PRAYER_READ

      public static final Capability PRAYER_READ
    • PRAYER_TOGGLE

      public static final Capability PRAYER_TOGGLE
    • MAGIC_CAST

      public static final Capability MAGIC_CAST
    • WIDGET_READ

      public static final Capability WIDGET_READ
      Whether a widget is drawn, its text and children.
    • WIDGET_INTERACT

      public static final Capability WIDGET_INTERACT
    • DIALOGUE_CONTINUE

      public static final Capability DIALOGUE_CONTINUE
    • DIALOGUE_OPTION

      public static final Capability DIALOGUE_OPTION
    • VARBIT_READ

      public static final Capability VARBIT_READ
    • VARP_READ

      public static final Capability VARP_READ
    • SKILL_READ

      public static final Capability SKILL_READ
    • XP_READ

      public static final Capability XP_READ
    • TRADE

      public static final Capability TRADE
    • SHOP_BUY

      public static final Capability SHOP_BUY
    • SHOP_SELL

      public static final Capability SHOP_SELL
    • PROJECTILE_EVENTS

      public static final Capability PROJECTILE_EVENTS
    • HITSPLAT_EVENTS

      public static final Capability HITSPLAT_EVENTS
    • GRAPHICS_EVENTS

      public static final Capability GRAPHICS_EVENTS
    • LOCAL_DEATH_EVENT

      public static final Capability LOCAL_DEATH_EVENT
      The local player's own death reaching plugins as an event (not by polling the animation).
    • OVERLAY_SCENE

      public static final Capability OVERLAY_SCENE
      Scene overlays: tiles and actors projected onto the game view.
    • CHAT_READ

      public static final Capability CHAT_READ
    • CHAT_SEND

      public static final Capability CHAT_SEND
    • TELEPORT

      public static final Capability TELEPORT
    • LOADOUT

      public static final Capability LOADOUT
    • RESTOCK

      public static final Capability RESTOCK
    • THREAT_READS

      public static final Capability THREAT_READS
      Reading who and what is threatening the player: attackers, projectiles, graphics, as one snapshot.
    • HAZARD_TILES

      public static final Capability HAZARD_TILES
      Hazard tiles and the safe tiles around them.
    • TARGETING

      public static final Capability TARGETING
      Choosing and keeping a target.
    • LOOT

      public static final Capability LOOT
      Looting wanted drops, chosen by name, item id or value, each pick proved by the carried count rising.
    • SUSTAIN

      public static final Capability SUSTAIN
      Staying alive and boosted: eating (combo eats included) and brewing for hitpoints, prayer restores, and stat boost doses such as overloads, each consume proved by the carried count dropping.
    • RECOVERY

      public static final Capability RECOVERY
      Getting back after a death: waiting out the respawn, reclaiming the dropped items where the server has a reclaim point, restocking and travelling back, with a plain-words reason for every way it can stop.
    • PVP_READS

      public static final Capability PVP_READS
      Detached opponent observations.
    • HOTKEYS

      public static final Capability HOTKEYS
      User-configured key presses queued for a plugin.
    • PVP_FIGHT_EVENTS

      public static final Capability PVP_FIGHT_EVENTS
      Newly observed local fight hits and graphics.
    • PVP_DAMAGE_MODEL

      public static final Capability PVP_DAMAGE_MODEL
      Historical per-weapon PvP damage distributions.
    • PVP_RISK

      public static final Capability PVP_RISK
      PvP risk valuation from detached containers and supplied rules.
    • PVP_WILDERNESS

      public static final Capability PVP_WILDERNESS
      Wilderness level from supplied verified coordinate rules.
    • PVP_ESCAPE

      public static final Capability PVP_ESCAPE
      Cancellable escape to a verified safe destination.
    • PVP_EFFECTS

      public static final Capability PVP_EFFECTS
      Server-specific freeze, vengeance and teleblock cue interpretation.
  • Method Details

    • values

      public static Capability[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static Capability valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null