Class User.Overhead
java.lang.Object
privbot.hooks.User.Overhead
- Enclosing class:
User
One read of the local overhead:
isReadable() false means nothing can be said about the
prayer the server shows — never treat it as "no overhead".-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final User.OverheadThe read failed, or the profile cannot name the id that is drawn. -
Method Summary
Modifier and TypeMethodDescriptionnet.runelite.api.HeadIconicon()The icon drawn, ornullwhen nothing is drawn or what is drawn blocks none of melee/ranged/magic (Elorin's Deflect Summoning, a blank sprite).booleanisNone()Readable, and noHeadIconis drawn.booleanlabel()The capture-row form: theHeadIconname,"NONE", ornullwhen unreadable.intrawId()The server's own icon id on Impact, Elorin and SpawnPK (255 or -1 = nothing drawn); the icon's ordinal or -1 on RuneLite-API servers;Integer.MIN_VALUEwhen unreadable.Whether the drawn overhead is the overhead of the prayer with this in-game name ("Protect from Magic", "Deflect Melee", "Soul Split"): a combined icon (Missiles + Magic) shows each part, and a curse shows its own icon.toString()
-
Field Details
-
UNREADABLE
The read failed, or the profile cannot name the id that is drawn.
-
-
Method Details
-
isReadable
public boolean isReadable()- Returns:
- whether anything can be said about the overhead (false: never treat as "no overhead")
-
icon
public net.runelite.api.HeadIcon icon()The icon drawn, ornullwhen nothing is drawn or what is drawn blocks none of melee/ranged/magic (Elorin's Deflect Summoning, a blank sprite). Also null when unreadable: checkisReadable()first. -
isNone
public boolean isNone()Readable, and noHeadIconis drawn. -
rawId
public int rawId()The server's own icon id on Impact, Elorin and SpawnPK (255 or -1 = nothing drawn); the icon's ordinal or -1 on RuneLite-API servers;Integer.MIN_VALUEwhen unreadable. -
label
The capture-row form: theHeadIconname,"NONE", ornullwhen unreadable. -
shows
Whether the drawn overhead is the overhead of the prayer with this in-game name ("Protect from Magic", "Deflect Melee", "Soul Split"): a combined icon (Missiles + Magic) shows each part, and a curse shows its own icon. Confirm a protection prayer with this rather thanctx.prayer.isActive(name), which reads false when it cannot read.- Parameters:
prayerName- the prayer's in-game name- Returns:
- true or false; null when the overhead is unreadable, the name is unknown, or the prayer draws no overhead (Piety, Protect Item, ...)
-
toString
-