Jump to content
Search In
  • More options...
Find results that contain...
Find results in...
Buy OSRS Gold

Sell OSRS Gold
Sign in to follow this  

[Snippet] Master Scroll Book

Recommended Posts

Here is a snippet that probably nobody will use, but I was bored and felt like making it.  


package scripts.Teleports;

import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.function.BooleanSupplier;

import org.tribot.api.General;
import org.tribot.api.Timing;
import org.tribot.api.interfaces.Clickable07;
import org.tribot.api2007.Game;
import org.tribot.api2007.Interfaces;
import org.tribot.api2007.Inventory;
import org.tribot.api2007.NPCChat;
import org.tribot.api2007.Player;
import org.tribot.api2007.types.RSInterface;
import org.tribot.api2007.types.RSItem;
import org.tribot.api2007.types.RSTile;
import org.tribot.api2007.types.RSVarBit;

public class MasterScrollBook {

	public static final int	INTERFACE_MASTER = 597;
	private static Map<String,Integer> cache = new HashMap<String,Integer>();
	public enum Teleports {
		NARDAH(5672,"Nardah",new RSTile(3419, 2916, 0)),
		DIGSITE(5673,"Digsite",new RSTile(3325, 3411, 0)),
		FELDIP_HILLS(5674,"Feldip Hills",new RSTile(2540, 2924, 0)),
		LUNAR_ISLE(5675,"Lunar Isle",new RSTile(2095, 3913, 0)),
		MORTTON(5676,"Mort'ton",new RSTile(3487, 3287, 0)),
		PEST_CONTROL(5677,"Pest Control",new RSTile(2658, 2658, 0)),
		PISCATORIS(5678,"Piscatoris",new RSTile(2340, 3650, 0)),
		TAI_BWO_WANNAI(5679,"Tai Bwo Wannai",new RSTile(2789,3065,0)),
		ELF_CAMP(5680,"Elf Camp",new RSTile(2193, 3258, 0)),
		MOS_LE_HARMLESS(5681,"Mos Le'Harmless", new RSTile(3700, 2996, 0)),
		LUMBERYARD(5682,"Lumberyard",new RSTile(3302, 3487, 0)),
		ZULLANDRA(5683,"Zul-Andra",new RSTile(2195, 3055, 0)),
		KEY_MASTER(5684,"Key Master",new RSTile(1311, 1251, 0)),
		REVENANT_CAVES(6056,"Revenant cave",new RSTile(3130, 3832, 0));
		private int varbit;
		private String name;
		private RSTile destination;
		Teleports(int varbit,String name,RSTile destination){
			this.varbit = varbit;
			this.name = name;
		//Returns the number of scrolls stored in the book.
		public int getCount(){
			RSVarBit var = RSVarBit.get(varbit);
			return var != null ? var.getValue() : 0;
		//Returns the name of the teleport.
		public String getName(){
			return name;
		//Returns the destination that the teleport will take you to.
		public RSTile getDestination(){
			return destination;
		//Sets the teleport as the default left-click option of the book.
		public boolean setAsDefault(){
			if(NPCChat.getOptions() != null){
				String text = getDefaultTeleportText();
					return NPCChat.selectOption("Yes", true);
			RSInterface target = getInterface(this);
			if(target == null)
				return false;
			return click(target,"Set as default") && waitForOptions() && NPCChat.selectOption("Yes", true);
		//Uses the teleport and waits until you arrive at the destination.
		public boolean use(){
			if(this == getDefault()){
				RSItem[] book = getBook();
				return book.length > 0 && click(book[0],"Teleport") && waitTillAtDestination(this);
			if(this == REVENANT_CAVES) // bug where you can't activate it from the interface for whatever reason.
				return setAsDefault() && use();
			RSInterface target = getInterface(this);
			return target != null && click(target, "Activate") && waitTillAtDestination(this);
	public static boolean teleport(Teleports teleport){
		return teleport != null && teleport.getCount() > 0 && teleport.use();
	public static int getCount(Teleports teleport){
		return teleport != null ? teleport.getCount() : 0;
	public static boolean isDefault(Teleports teleport){
		return getDefault() == teleport;
	public static boolean setAsDefault(Teleports teleport){
		return teleport != null && teleport.setAsDefault();
	public static Teleports getDefault(){
		RSVarBit defaultTeleport = RSVarBit.get(5685);
		int value;
		if(defaultTeleport == null || (value = defaultTeleport.getValue()) == 0)
			return null;
		return Teleports.values()[value-1];
	//Removes the default left click teleport option.
	public static boolean removeDefault(){
		RSItem[] book = getBook();
		return book.length > 0 && click(book[0],"Remove default") && waitForOptions() && NPCChat.selectOption("Yes", true);
	//Caches the index and returns the RSInterface associated with the selected teleport.
	private static RSInterface getInterface(Teleports teleport){
			return Interfaces.get(INTERFACE_MASTER,cache.get(teleport.getName()));
		RSInterface master = Interfaces.get(INTERFACE_MASTER);
		for(RSInterface child:master.getChildren()){
			String name = child.getComponentName();
			if(name == null){
			} else if(name.startsWith("<") && General.stripFormatting(name).contains(teleport.getName())){
				cache.put(teleport.getName(), child.getIndex());
				return child;
		return null;
	//Returns true if the Master scroll book interface is open.
	public static boolean isOpen(){
		return Interfaces.isInterfaceSubstantiated(INTERFACE_MASTER);
	//Opens the master scroll book interface.
	public static boolean openBook(){
		RSItem[] book = getBook();
		return book.length > 0 && click(book[0],"Open") && waitForBookToOpen();
	private static RSItem[] getBook(){
		return Inventory.find("Master scroll book");
	private static boolean waitForBookToOpen(){
		return Timing.waitCondition(new BooleanSupplier(){

			public boolean getAsBoolean() {
				return isOpen();
		}, 5000);
	private static boolean waitForOptions(){
		return Timing.waitCondition(new BooleanSupplier(){

			public boolean getAsBoolean() {
				return NPCChat.getOptions().length > 0;
		}, 5000);
	//Checks which scroll we are setting to default currently.
	private static String getDefaultTeleportText(){
		RSInterface master = Interfaces.get(219,1);
		if(master == null)
			return null;
		RSInterface[] ifaces = master.getChildren();
		if(ifaces == null)
			return null;
		for(RSInterface iface:ifaces){
			String txt = iface.getText();
			if(txt == null || !txt.startsWith("Set"))
			return txt;
		return null;
	//Resets uptext.
	private static void resetUptext(){
		RSInterface master = Interfaces.get(161);
		RSInterface[] children = master.getChildren();
		if(children == null)
		RSInterface inventory = null;
		for(RSInterface child:children){
			String[] actions = child.getActions();
			if(actions == null || actions.length == 0)
				inventory = child;
		if(inventory != null)
	private static boolean waitTillAtDestination(Teleports location){
		return Timing.waitCondition(new BooleanSupplier(){

			public boolean getAsBoolean() {
				return location.getDestination().distanceTo(Player.getPosition()) < 10;
		}, 8000);
	private static boolean click(Clickable07 clickable, String action){
		if(Game.isUptext("->") && !action.contains("->")){
		return clickable.click(action);


Example usage:



  • Like 2

Share this post

Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Sign in to follow this  

  • Our picks

    • Over the past few months, I’ve been working diligently on a new project - TRiBot X. Everything has been written from the ground up, with all of the best practices of software engineering. Every aspect of TRiBot has been re-imagined to support three main goals: flexibility, useability, and reliability.
        • Like
      • 31 replies
    • Come give us feedback on the next version of TRiBot!
        • Thanks
        • Like
      • 74 replies
    • TRiBot is looking to improve a lot of its customer relationship management, customer on boarding process, customer experience, design elements, community engagement and pretty much everything else you can imagine when it comes to marketing.

      Our goal: To ensure that the marketing done TRULY reflects the experience and does not shine an inaccurate light on what TRiBot is lacking in.

      So I ask, what do you love about TRiBot and what do you hate about TRiBot? What does O S Bot, Rune M8, PowR Bot and Dre amBot do better? (yes I purposely didn't spell it right 😂).


        • Like
      • 23 replies
    • Over the last three weeks, I've been working on upgrading our server infrastructure. It's finally ready and is now live!


      Increased reliability - less server errors

      Increased availability - less downtime

      Increased security - keeping us and you secure

      Increased capacity - ability to serve you better

      Increased speed - less waiting for things to load

      Faster development - server and service updates will come faster

      What are the changes?

      Move from a single AWS EC2 instance to AWS ECS (Elastic Container Service)

      Distributed computing

      Load balancing

      Git management of server files and filesystem

      Redis caching


      AWS ECS (with 10 EC2 instances)

      AWS ElastiCache (Redis)

      AWS Load Balancing

      AWS EFS (Elastic file system)

      Please bare with us as I continue to tune the server for maximum performance. Slow loading speeds may occur temporarily. I thank everyone for their patience.

      Please post on this thread if you experience any issues other than slow loading times.
        • Like
      • 51 replies
    • This release will:

      Fix prayers and world hopper API (Thanks @JoeDezzy1 and @erickho123)

      Improve banking API (Thanks @Encoded)

      Adds methods for returning and using Java Lists, rather than arrays

      Slightly randomizes some hardcoded behaviour

      Removes sleeps from waitConditions; the efficiency saving potential is negligible in these use-cases, therefore cleaner code is preferable

      Other back-end improvements

      Note: If you are using LG, please restart both the RS client and TRiBot.
        • Sad
        • Haha
        • Thanks
        • Like
      • 90 replies
  • Recently Browsing   0 members

    No registered users viewing this page.

  • Create New...