Package net.runelite.api

Class Varbits

    • Field Detail

      • RUN_SLOWED_DEPLETION_ACTIVE

        public static final int RUN_SLOWED_DEPLETION_ACTIVE
        See Also:
        Constant Field Values

      • STAMINA_EFFECT

        public static final int STAMINA_EFFECT
        Stamina effect timer Number of game ticks remaining on stamina effect in intervals of 10; for a value X there are 10 * X game ticks remaining. The stamina effect expires once this reaches 0.
        See Also:
        Constant Field Values

      • ANTIFIRE

        public static final int ANTIFIRE
        Antifire timer Number of game ticks remaining on antifire in intervals of 30; for a value X there are 30 * X game ticks remaining. The antifire expires once this reaches 0.
        See Also:
        Constant Field Values

      • SUPER_ANTIFIRE

        public static final int SUPER_ANTIFIRE
        Super Antifire timer Number of game ticks remaining on super antifire in intervals of 20; for a value X there are 20 * X game ticks remaining. The super antifire expires once this reaches 0.
        See Also:
        Constant Field Values

      • MAGIC_IMBUE

        public static final int MAGIC_IMBUE
        Magic imbue timer Number of game ticks remaining on magic imbue effect in intervals of 10; for a value X there are 10 * X game ticks remaining. The magic imbue effect expires once this reaches 0.
        See Also:
        Constant Field Values

      • DIVINE_SUPER_ATTACK

        public static final int DIVINE_SUPER_ATTACK
        Divine effect timers Number of game ticks remaining on a divine effect. A potion that combines multiple effects will set the varbits for the individual effects as well as its own effect.
        See Also:
        Constant Field Values

      • RING_OF_ENDURANCE_EFFECT

        public static final int RING_OF_ENDURANCE_EFFECT
        Ring of endurance effect timer, stamina duration extended from using the ring of endurance Number of game ticks remaining on ring of endurance effect in intervals of 10; for a value X there are 10 * X game ticks remaining. Unequipping the ring of endurance will cause this to change to 0. When this reaches 0, STAMINA_EFFECT will begin counting down.
        See Also:
        Constant Field Values

      • CHAT_SCROLLBAR_ON_LEFT

        public static final int CHAT_SCROLLBAR_ON_LEFT
        If scrollbar in resizable mode chat is on the left
        See Also:
        Constant Field Values

      • PRAYER_BURST_OF_STRENGTH

        public static final int PRAYER_BURST_OF_STRENGTH
        See Also:
        Constant Field Values

      • PRAYER_CLARITY_OF_THOUGHT

        public static final int PRAYER_CLARITY_OF_THOUGHT
        See Also:
        Constant Field Values

      • PRAYER_SUPERHUMAN_STRENGTH

        public static final int PRAYER_SUPERHUMAN_STRENGTH
        See Also:
        Constant Field Values

      • PRAYER_IMPROVED_REFLEXES

        public static final int PRAYER_IMPROVED_REFLEXES
        See Also:
        Constant Field Values

      • PRAYER_ULTIMATE_STRENGTH

        public static final int PRAYER_ULTIMATE_STRENGTH
        See Also:
        Constant Field Values

      • PRAYER_INCREDIBLE_REFLEXES

        public static final int PRAYER_INCREDIBLE_REFLEXES
        See Also:
        Constant Field Values

      • PRAYER_PROTECT_FROM_MAGIC

        public static final int PRAYER_PROTECT_FROM_MAGIC
        See Also:
        Constant Field Values

      • PRAYER_PROTECT_FROM_MISSILES

        public static final int PRAYER_PROTECT_FROM_MISSILES
        See Also:
        Constant Field Values

      • PRAYER_PROTECT_FROM_MELEE

        public static final int PRAYER_PROTECT_FROM_MELEE
        See Also:
        Constant Field Values

      • PRAYER_RP_REJUVENATION

        public static final int PRAYER_RP_REJUVENATION
        Ruinous Powers
        See Also:
        Constant Field Values

      • PRAYER_RP_ANCIENT_STRENGTH

        public static final int PRAYER_RP_ANCIENT_STRENGTH
        See Also:
        Constant Field Values

      • PRAYER_RP_ANCIENT_SIGHT

        public static final int PRAYER_RP_ANCIENT_SIGHT
        See Also:
        Constant Field Values

      • PRAYER_RP_RUINOUS_GRACE

        public static final int PRAYER_RP_RUINOUS_GRACE
        See Also:
        Constant Field Values

      • PRAYER_RP_DAMPEN_RANGED

        public static final int PRAYER_RP_DAMPEN_RANGED
        See Also:
        Constant Field Values

      • DIARY_ARDOUGNE_EASY

        public static final int DIARY_ARDOUGNE_EASY
        Diary Entries
        See Also:
        Constant Field Values

      • DIARY_WILDERNESS_MEDIUM

        public static final int DIARY_WILDERNESS_MEDIUM
        See Also:
        Constant Field Values

      • KOUREND_FAVOR_ARCEUUS

        public static final int KOUREND_FAVOR_ARCEUUS
        Kourend house favours
        See Also:
        Constant Field Values

      • KOUREND_FAVOR_LOVAKENGJ

        public static final int KOUREND_FAVOR_LOVAKENGJ
        See Also:
        Constant Field Values

      • KOUREND_FAVOR_PISCARILIUS

        public static final int KOUREND_FAVOR_PISCARILIUS
        See Also:
        Constant Field Values

      • EQUIPPED_WEAPON_TYPE

        public static final int EQUIPPED_WEAPON_TYPE
        Equipped weapon type
        See Also:
        Constant Field Values

      • DEFENSIVE_CASTING_MODE

        public static final int DEFENSIVE_CASTING_MODE
        Defensive casting mode
        See Also:
        Constant Field Values

      • HB_TRAIL_31303

        public static final int HB_TRAIL_31303
        Herbiboar Trails
        See Also:
        Constant Field Values

      • HB_STARTED

        public static final int HB_STARTED
        Started hunting Herbiboar.
        NOTE: This value remains at 0 even after starting a Herbiboar trail up until searching the first object along the hunting path.
        See Also:
        Constant Field Values

      • IN_WILDERNESS

        public static final int IN_WILDERNESS
        0 = Outside wilderness 1 = In wilderness
        See Also:
        Constant Field Values

      • FISHING_TRAWLER_ACTIVITY

        public static final int FISHING_TRAWLER_ACTIVITY
        Fishing Trawler FISHING_TRAWLER_ACTIVITY Expected values: 0-255
        See Also:
        Constant Field Values

      • BAR_DISPENSER

        public static final int BAR_DISPENSER
        Blast Furnace Bar Dispenser

        These are the expected values: 0 = No bars being processed 1 = Ores are being processed on the conveyor belt, bar dispenser cannot be checked 2 = Bars are cooling down 3 = Bars can be collected

        See Also:
        Constant Field Values

      • EXPERIENCE_TRACKER_POSITION

        public static final int EXPERIENCE_TRACKER_POSITION
        Experience tracker

        EXPERIENCE_TRACKER_POSITION expected values: 0 = Right 1 = Middle 2 = Left

        See Also:
        Constant Field Values

      • EXPERIENCE_TRACKER_COUNTER

        public static final int EXPERIENCE_TRACKER_COUNTER
        See Also:
        Constant Field Values

      • EXPERIENCE_TRACKER_PROGRESS_BAR

        public static final int EXPERIENCE_TRACKER_PROGRESS_BAR
        See Also:
        Constant Field Values

      • EXPERIENCE_DROP_COLOR

        public static final int EXPERIENCE_DROP_COLOR
        Experience drop color
        See Also:
        Constant Field Values

      • TITHE_FARM_SACK_AMOUNT

        public static final int TITHE_FARM_SACK_AMOUNT
        Tithe Farm
        See Also:
        Constant Field Values

      • FIRE_PIT_GIANT_MOLE

        public static final int FIRE_PIT_GIANT_MOLE
        Making Friends with My Arm fire pits

        Expected values: 0 = Not built 1 = Built

        See Also:
        Constant Field Values

      • FIRE_PIT_LUMBRIDGE_SWAMP

        public static final int FIRE_PIT_LUMBRIDGE_SWAMP
        See Also:
        Constant Field Values

      • FIRE_PIT_MOS_LE_HARMLESS

        public static final int FIRE_PIT_MOS_LE_HARMLESS
        See Also:
        Constant Field Values

      • THEATRE_OF_BLOOD

        public static final int THEATRE_OF_BLOOD
        Theatre of Blood 1=In Party, 2=Inside/Spectator, 3=Dead Spectating
        See Also:
        Constant Field Values

      • THEATRE_OF_BLOOD_ORB1

        public static final int THEATRE_OF_BLOOD_ORB1
        Theatre of Blood orb healths 0=hide 1-27=% of health - 27 is 100% health and 1 is 0% health, 30=dead
        See Also:
        Constant Field Values

      • BLAST_FURNACE_COPPER_ORE

        public static final int BLAST_FURNACE_COPPER_ORE
        Blast Furnace
        See Also:
        Constant Field Values

      • BLAST_FURNACE_MITHRIL_ORE

        public static final int BLAST_FURNACE_MITHRIL_ORE
        See Also:
        Constant Field Values

      • BLAST_FURNACE_ADAMANTITE_ORE

        public static final int BLAST_FURNACE_ADAMANTITE_ORE
        See Also:
        Constant Field Values

      • BLAST_FURNACE_RUNITE_ORE

        public static final int BLAST_FURNACE_RUNITE_ORE
        See Also:
        Constant Field Values

      • BLAST_FURNACE_SILVER_ORE

        public static final int BLAST_FURNACE_SILVER_ORE
        See Also:
        Constant Field Values

      • BLAST_FURNACE_BRONZE_BAR

        public static final int BLAST_FURNACE_BRONZE_BAR
        See Also:
        Constant Field Values

      • BLAST_FURNACE_STEEL_BAR

        public static final int BLAST_FURNACE_STEEL_BAR
        See Also:
        Constant Field Values

      • BLAST_FURNACE_MITHRIL_BAR

        public static final int BLAST_FURNACE_MITHRIL_BAR
        See Also:
        Constant Field Values

      • BLAST_FURNACE_ADAMANTITE_BAR

        public static final int BLAST_FURNACE_ADAMANTITE_BAR
        See Also:
        Constant Field Values

      • BLAST_FURNACE_RUNITE_BAR

        public static final int BLAST_FURNACE_RUNITE_BAR
        See Also:
        Constant Field Values

      • BLAST_FURNACE_SILVER_BAR

        public static final int BLAST_FURNACE_SILVER_BAR
        See Also:
        Constant Field Values

      • PYRAMID_PLUNDER_ROOM_LOCATION

        public static final int PYRAMID_PLUNDER_ROOM_LOCATION
        Pyramid plunder
        See Also:
        Constant Field Values

      • PYRAMID_PLUNDER_THIEVING_LEVEL

        public static final int PYRAMID_PLUNDER_THIEVING_LEVEL
        See Also:
        Constant Field Values

      • BARROWS_KILLED_AHRIM

        public static final int BARROWS_KILLED_AHRIM
        Barrows
        See Also:
        Constant Field Values

      • BARROWS_REWARD_POTENTIAL

        public static final int BARROWS_REWARD_POTENTIAL
        See Also:
        Constant Field Values

      • SPICY_STEW_RED_SPICES

        public static final int SPICY_STEW_RED_SPICES
        Spicy stew ingredients
        See Also:
        Constant Field Values

      • SPICY_STEW_YELLOW_SPICES

        public static final int SPICY_STEW_YELLOW_SPICES
        See Also:
        Constant Field Values

      • SPICY_STEW_BROWN_SPICES

        public static final int SPICY_STEW_BROWN_SPICES
        See Also:
        Constant Field Values

      • SPICY_STEW_ORANGE_SPICES

        public static final int SPICY_STEW_ORANGE_SPICES
        See Also:
        Constant Field Values

      • MULTICOMBAT_AREA

        public static final int MULTICOMBAT_AREA
        Multicombat area
        See Also:
        Constant Field Values

      • KINGDOM_APPROVAL

        public static final int KINGDOM_APPROVAL
        Kingdom of Miscellania Management Kingdom Approval is represented as a 7-bit unsigned integer; 127 corresponds to 100% approval
        See Also:
        Constant Field Values

      • QUEST_THE_HAND_IN_THE_SAND

        public static final int QUEST_THE_HAND_IN_THE_SAND
        The Hand in the Sand quest status
        See Also:
        Constant Field Values

      • DAILY_HERB_BOXES_COLLECTED

        public static final int DAILY_HERB_BOXES_COLLECTED
        Daily Tasks =Collection availability)
        See Also:
        Constant Field Values

      • DAILY_ESSENCE_COLLECTED

        public static final int DAILY_ESSENCE_COLLECTED
        See Also:
        Constant Field Values

      • DAILY_BONEMEAL_STATE

        public static final int DAILY_BONEMEAL_STATE
        This varbit tracks how much bonemeal has been redeemed from Robin The player gets 13 for each diary completed above and including Medium, for a maxiumum of 39
        See Also:
        Constant Field Values

      • DAILY_DYNAMITE_COLLECTED

        public static final int DAILY_DYNAMITE_COLLECTED
        See Also:
        Constant Field Values

      • FAIR_RING_LAST_DESTINATION

        public static final int FAIR_RING_LAST_DESTINATION
        Fairy Ring
        See Also:
        Constant Field Values

      • FARMING_4771

        public static final int FARMING_4771
        Transmog controllers for farming
        See Also:
        Constant Field Values

      • GRAPES_4953

        public static final int GRAPES_4953
        Transmog controllers for grapes
        See Also:
        Constant Field Values

      • AUTOWEED

        public static final int AUTOWEED
        Automatically weed farming patches
        See Also:
        Constant Field Values

      • ACCOUNT_TYPE

        public static final int ACCOUNT_TYPE
        The player's account type.

        0 = normal 1 = ironman 2 = ultimate ironman 3 = hardcore ironman 4 = group ironman 5 = hardcore group ironman 6 = unranked group ironman

        See Also:
        Constant Field Values

      • OXYGEN_LEVEL

        public static final int OXYGEN_LEVEL
        The varbit that stores the oxygen percentage for player
        See Also:
        Constant Field Values

      • NORTH_NET_STATUS

        public static final int NORTH_NET_STATUS
        Drift net status

        Expected values 0 = Unset 1 = Set up 2 = Caught some fish 3 = Full

        See Also:
        Constant Field Values

      • NORTH_NET_CATCH_COUNT

        public static final int NORTH_NET_CATCH_COUNT
        Drift net catch count
        See Also:
        Constant Field Values

      • DRIFT_NET_COLLECT

        public static final int DRIFT_NET_COLLECT
        Drift net collect interface

        Expected values: 0 = Not open 1 = North interface open 2 = South interface open

        See Also:
        Constant Field Values

      • SUPERIOR_ENABLED

        public static final int SUPERIOR_ENABLED
        Toggleable slayer unlocks
        See Also:
        Constant Field Values

      • FOSSIL_ISLAND_WYVERN_DISABLE

        public static final int FOSSIL_ISLAND_WYVERN_DISABLE
        See Also:
        Constant Field Values

      • VENGEANCE_ACTIVE

        public static final int VENGEANCE_ACTIVE
        Spell activeness
        See Also:
        Constant Field Values

      • HEAL_GROUP_COOLDOWN

        public static final int HEAL_GROUP_COOLDOWN
        Spell cooldowns
        See Also:
        Constant Field Values

      • RESURRECT_THRALL_COOLDOWN

        public static final int RESURRECT_THRALL_COOLDOWN
        See Also:
        Constant Field Values

      • WARD_OF_ARCEUUS_COOLDOWN

        public static final int WARD_OF_ARCEUUS_COOLDOWN
        See Also:
        Constant Field Values

      • IMBUED_HEART_COOLDOWN

        public static final int IMBUED_HEART_COOLDOWN
        Imbued Heart cooldown Number of game tick remaining on cooldown in intervals of 10; for a value X there are 10 * X game ticks remaining. The heart regains its power once this reaches 0.
        See Also:
        Constant Field Values

      • DRAGONFIRE_SHIELD_COOLDOWN

        public static final int DRAGONFIRE_SHIELD_COOLDOWN
        Dragonfire shield cooldown

        Number of game ticks remaining on cooldown in intervals of 8; for a value X there are 8 * X game ticks remaining.

        See Also:
        Constant Field Values

      • BANK_TAB_ONE_COUNT

        public static final int BANK_TAB_ONE_COUNT
        Amount of items in each bank tab
        See Also:
        Constant Field Values

      • GE_OFFER_CREATION_TYPE

        public static final int GE_OFFER_CREATION_TYPE
        Type of GE offer currently being created 0 = buy 1 = sell
        See Also:
        Constant Field Values

      • QUEST_TAB

        public static final int QUEST_TAB
        The active tab within the quest interface
        See Also:
        Constant Field Values

      • EXPLORER_RING_ALCHTYPE

        public static final int EXPLORER_RING_ALCHTYPE
        Explorer ring
        See Also:
        Constant Field Values

      • EXPLORER_RING_TELEPORTS

        public static final int EXPLORER_RING_TELEPORTS
        See Also:
        Constant Field Values

      • EXPLORER_RING_RUNENERGY

        public static final int EXPLORER_RING_RUNENERGY
        See Also:
        Constant Field Values

      • MUTED_MUSIC_VOLUME

        public static final int MUTED_MUSIC_VOLUME
        Muted volume restore values
        See Also:
        Constant Field Values

      • MUTED_SOUND_EFFECT_VOLUME

        public static final int MUTED_SOUND_EFFECT_VOLUME
        See Also:
        Constant Field Values

      • MUTED_AREA_EFFECT_VOLUME

        public static final int MUTED_AREA_EFFECT_VOLUME
        See Also:
        Constant Field Values

      • PARASITE

        public static final int PARASITE
        Parasite infection status during nightmare of ashihama bossfight

        0 = not infected 1 = infected

        See Also:
        Constant Field Values

      • WIKI_ENTITY_LOOKUP

        public static final int WIKI_ENTITY_LOOKUP
        Whether the vanilla wiki entity lookup is displayed under the minimap

        0 = Enabled 1 = Disabled

        See Also:
        Constant Field Values

      • PVP_SPEC_ORB

        public static final int PVP_SPEC_ORB
        Whether the player is in a PvP area

        0 = Player is not in PvP area 1 = Player is in PvP area

        Note: The name of this varbit comes from historical behavior where the special attack orb would be disabled in PvP, but this was changed on 2023-03-09 due to Poll 78. Yet, the varbit still updates as before.

        See Also:
        Constant Field Values

      • COLLECTION_LOG_NOTIFICATION

        public static final int COLLECTION_LOG_NOTIFICATION
        Collection Log notification settings whenever a new item is added

        0 = no notification 1 = chat notification only 2 = popup notification only 3 = chat and popup

        See Also:
        Constant Field Values

      • COMBAT_ACHIEVEMENTS_POPUP

        public static final int COMBAT_ACHIEVEMENTS_POPUP
        Combat Achievements popup settings whenever a new task is completed

        0 = popup notification enabled 1 = popup notification disabled

        See Also:
        Constant Field Values

      • COMBAT_ACHIEVEMENT_TIER_EASY

        public static final int COMBAT_ACHIEVEMENT_TIER_EASY
        Combat Achievement tier completion variables 2 = completed
        See Also:
        Constant Field Values

      • COMBAT_ACHIEVEMENT_TIER_MEDIUM

        public static final int COMBAT_ACHIEVEMENT_TIER_MEDIUM
        See Also:
        Constant Field Values

      • COMBAT_ACHIEVEMENT_TIER_HARD

        public static final int COMBAT_ACHIEVEMENT_TIER_HARD
        See Also:
        Constant Field Values

      • COMBAT_ACHIEVEMENT_TIER_ELITE

        public static final int COMBAT_ACHIEVEMENT_TIER_ELITE
        See Also:
        Constant Field Values

      • COMBAT_ACHIEVEMENT_TIER_MASTER

        public static final int COMBAT_ACHIEVEMENT_TIER_MASTER
        See Also:
        Constant Field Values

      • COMBAT_ACHIEVEMENT_TIER_GRANDMASTER

        public static final int COMBAT_ACHIEVEMENT_TIER_GRANDMASTER
        See Also:
        Constant Field Values

      • BOSS_HEALTH_OVERLAY

        public static final int BOSS_HEALTH_OVERLAY
        Show boss health overlay setting 0 = on 1 = off
        See Also:
        Constant Field Values

      • BOSS_HEALTH_CURRENT

        public static final int BOSS_HEALTH_CURRENT
        Boss health bar info
        See Also:
        Constant Field Values

      • SHOW_PVP_KDR_STATS

        public static final int SHOW_PVP_KDR_STATS
        Whether the PVP kill-death stats widget should be drawn while in the wilderness or in PVP worlds.

        0 = Disabled 1 = Enabled

        See Also:
        Constant Field Values

      • TELEBLOCK

        public static final int TELEBLOCK
        State of Teleblock spell effects on the player

        0 = Teleblock inactive, no immunity 1 <= X <= 100 = Teleblock inactive, remaining ticks of immunity from reapplication of spell effect 101 <= Teleblock active, remaining ticks of blocking effect

        See Also:
        Constant Field Values

      • GOD_WARS_ALTAR_COOLDOWN

        public static final int GOD_WARS_ALTAR_COOLDOWN
        Cooldown timer remaining before eligible to restore at a god wars dungeon altar. Number of game ticks remaining is in intervals of 100; for a value X there are 100 * X game ticks remaining. A player can pray at a god wars altar once this reaches 0.
        See Also:
        Constant Field Values

      • FARMERS_AFFINITY

        public static final int FARMERS_AFFINITY
        Farmer's Affinity effect timer Number of game ticks remaining on Farmer's Affinity effect in intervals of 20; for a value X there are 20 * X game ticks remaining. The Farmer's Affinity expires once this reaches 0.
        See Also:
        Constant Field Values

      • MENAPHITE_REMEDY

        public static final int MENAPHITE_REMEDY
        If the player has Menaphite remedy effect active. This will go down by 1 every 25 ticks (15 seconds) and the player's combat stats will be restored by 6 + 16%. Set to 20 upon consuming potion.
        See Also:
        Constant Field Values

      • BUFF_STAT_BOOST

        public static final int BUFF_STAT_BOOST
        How many salt stat boost refreshes the player has remaining. This will go down by 1 every 25 ticks (15 seconds) and the player's stats will be restored. Set to 32 upon crushing salts.
        See Also:
        Constant Field Values

      • LIQUID_ADERNALINE_ACTIVE

        public static final int LIQUID_ADERNALINE_ACTIVE
        If the player has liquid adrenaline buff active

        0 = inactive 1 = active

        See Also:
        Constant Field Values

      • TOA_MEMBER_0_HEALTH

        public static final int TOA_MEMBER_0_HEALTH
        Tombs of Amascut orb healths 0=hide 1-27=% of health - 27 is 100% health and 1 is 0% health, 30=dead
        See Also:
        Constant Field Values

      • NMZ_OVERLOAD_REFRESHES_REMAINING

        public static final int NMZ_OVERLOAD_REFRESHES_REMAINING
        How many NMZ overload refreshes the player has remaining.

        This will go down by 1 every 25 ticks (15 seconds) and the player's stats will be restored. Set to 20 upon drinking an overload.

        See Also:
        Constant Field Values

      • COX_OVERLOAD_REFRESHES_REMAINING

        public static final int COX_OVERLOAD_REFRESHES_REMAINING
        How many Chambers of Xeric overload refreshes the player has remaining.

        This will go down by 1 every 25 ticks (15 seconds) and the player's stats will be restored. Set to 20 upon drinking an overload.

        See Also:
        Constant Field Values

      • SLAYER_TASK_BOSS

        public static final int SLAYER_TASK_BOSS
        The assigned boss for boss slayer.
        See Also:
        Constant Field Values

      • DISABLE_LEVEL_UP_INTERFACE

        public static final int DISABLE_LEVEL_UP_INTERFACE
        Whether the level up interface is disabled
        See Also:
        Constant Field Values

      • VIGGORA_LOCATION

        public static final int VIGGORA_LOCATION
        During and after Curse of the Empty Lord, Viggora can be located in one of three locations, which is uniquely and permanently set for each player. This varbit determines which location he will appear in, which is useful for a master clue step.
        See Also:
        Constant Field Values

      • SPELLBOOK_SWAP

        public static final int SPELLBOOK_SWAP
        If the player has a spellbook swap active

        0 = inactive 1 = active

        See Also:
        Constant Field Values

    • Constructor Detail

      • Varbits

        public Varbits()