Enum Capability
- All Implemented Interfaces:
Serializable,Comparable<Capability>,java.lang.constant.Constable
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionHazard tiles and the safe tiles around them.User-configured key presses queued for a plugin.The local player's own death reaching plugins as an event (not by polling the animation).Looting wanted drops, chosen by name, item id or value, each pick proved by the carried count rising.Scene overlays: tiles and actors projected onto the game view.Historical per-weapon PvP damage distributions.Server-specific freeze, vengeance and teleblock cue interpretation.Cancellable escape to a verified safe destination.Newly observed local fight hits and graphics.Detached opponent observations.PvP risk valuation from detached containers and supplied rules.Wilderness level from supplied verified coordinate rules.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.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.Choosing and keeping a target.Reading who and what is threatening the player: attackers, projectiles, graphics, as one snapshot.Walking to a tile that is on screen.Walking to a tile that is not on screen in one call.Whether a widget is drawn, its text and children. -
Method Summary
Modifier and TypeMethodDescriptionstatic CapabilityReturns the enum constant of this type with the specified name.static Capability[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
INVENTORY_READ
-
INVENTORY_INTERACT
-
EQUIPMENT_READ
-
EQUIPMENT_INTERACT
-
BANK_READ
-
BANK_OPEN
-
BANK_WITHDRAW
-
BANK_DEPOSIT
-
BANK_CLOSE
-
NPC_READ
-
NPC_INTERACT
-
NPC_ATTACK
-
OBJECT_READ
-
OBJECT_INTERACT
-
GROUND_ITEM_READ
-
GROUND_ITEM_TAKE
-
PLAYER_READ
-
LOCAL_PLAYER_READ
-
GAME_STATE_READ
-
RUN_TOGGLE
-
WALK
Walking to a tile that is on screen. -
WALK_OFFSCREEN
Walking to a tile that is not on screen in one call. -
PRAYER_READ
-
PRAYER_TOGGLE
-
MAGIC_CAST
-
WIDGET_READ
Whether a widget is drawn, its text and children. -
WIDGET_INTERACT
-
DIALOGUE_CONTINUE
-
DIALOGUE_OPTION
-
VARBIT_READ
-
VARP_READ
-
SKILL_READ
-
XP_READ
-
TRADE
-
SHOP_BUY
-
SHOP_SELL
-
PROJECTILE_EVENTS
-
HITSPLAT_EVENTS
-
GRAPHICS_EVENTS
-
LOCAL_DEATH_EVENT
The local player's own death reaching plugins as an event (not by polling the animation). -
OVERLAY_SCENE
Scene overlays: tiles and actors projected onto the game view. -
CHAT_READ
-
CHAT_SEND
-
TELEPORT
-
LOADOUT
-
RESTOCK
-
THREAT_READS
Reading who and what is threatening the player: attackers, projectiles, graphics, as one snapshot. -
HAZARD_TILES
Hazard tiles and the safe tiles around them. -
TARGETING
Choosing and keeping a target. -
LOOT
Looting wanted drops, chosen by name, item id or value, each pick proved by the carried count rising. -
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
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
Detached opponent observations. -
HOTKEYS
User-configured key presses queued for a plugin. -
PVP_FIGHT_EVENTS
Newly observed local fight hits and graphics. -
PVP_DAMAGE_MODEL
Historical per-weapon PvP damage distributions. -
PVP_RISK
PvP risk valuation from detached containers and supplied rules. -
PVP_WILDERNESS
Wilderness level from supplied verified coordinate rules. -
PVP_ESCAPE
Cancellable escape to a verified safe destination. -
PVP_EFFECTS
Server-specific freeze, vengeance and teleblock cue interpretation.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-