[Snippet] Actions & Doors

[Purple]

This is a mini tutorial on how to use actions to check if a door is open or closed based on a certain tile and action strings. This is useful for writing scripts which require you to pass through a door pathway.

 

NOTE: Using this snippet you will NEVER need to update door IDs as you will be using strings.

 

 

What are actions?

actions are exactly what they sound like. Almost everything in RuneScape contains actions and we can abuse this to tell if certain players, objects, NPCs, etc contain certain menu options without having to even click on them. This will be useful for telling if a door is actually opened or closed!

 

Step 1: Creating the action identifier

 

First let's make a boolean called "checkDoorIsOpen" and inside this boolean we will be checking to see if an object is not null and it's action contains a certain string to verify that a door is actually closed or open. 

private boolean checkDoorIsOpen() {

        final RS2Object door = closestObjectForName(doorTile, "Door");

        if(door != null) {
            for(String actions: door.getDefinition().getActions()) {
                if(actions.contains("Open")) {
                    return true;
                }
            }
        }
        return false;
    }

You might have noticed we used an area filter to filter out the unwanted doors, and yes, you can use the same two tiles for an area.

 

Area Example

private final Area doorArea = new Area(1111, 2222, 1111, 2222);

Step 2: Now that we have our action identifier how do we use it?

 

We use a simple if statement to determine weither the door is open or closed based on our identifier above 

if(checkDoorIsOpen()) {
     status = "Opening the door";
     door.interact("Open");
} else if(!checkDoorIsOpen()) {
     //CODE HERE
}

As you can see in the statement above if our boolean checkDoorIsOpen returns true the door on that tile must contain an Open action meaning the door must be closed resulting in the bot opening the door. Now If the condition returns false it will ignore the door interaction code and run our normal code. 

 

The reason I prefer this method over just checking to see if the door is null based on ID is because JaGex changes the IDs all the time and there's a new update coming soon where IDs will be dynamic for everyone. 

 

Hopefully this will help out some of the newer people or teach others new ways of checking if something is there or not besides just checking to see if its null or not. This can be applied to many objects, not just doors.

 

Edited July 30, 2013 by PurpleK

[Joseph]

I appreciate you taking the time to write up this little helpful tutorial. This will help out many people. I will be using this soon on my scripts.

Edited July 30, 2013 by josedpay

[ohhungry]

Little mistake in the snippet (or atleast confusing), the way you have it setup, checkDoorIsOpen() will return false if the door is actually open, because if the door is open, the action read will be "Close". Just gotta switch if(actions.contains("Open") to if(actions.contains("Close")

 

Edit: Nevermind, it's late and I didn't read the rest of the post :P Kinda weird though having a checkDoorIsOpen return false if it's open. Also, I keep getting a nullpointer when it tries to search for the action thats not there

Edited August 9, 2013 by ohhungry

[Mr Asshole]

Try to check the menu has options before trying to read the options.

[TheScrub]

Purple representing the snippet section yer!

[Cory]

Your logic and implementation logic seems off, you're checking if the door is open, but returning true if its closed and the way you're telling them to use it doesn't make sense, they don't have access to the door variable inside checkDoorIsOpen as its Scope is only inside that method.

 

It would make more sense to pass the door area and have that method handle opening the door, something along the lines of;

Area doorArea = new Area(x, y, x, y);
if(openDoor(doorArea)) {
	//CODE HERE
}

private boolean openDoor(Area area) throws InterruptedException {
	RS2Object door = closestObjectForName(area, "Door");
	if(door != null && door.getDefinition() != null) {
		if(hasAction(door.getDefinition().getActions(), "Open")) {
			return door.interact("Open");
		}
	}
	return true;
}

public boolean hasAction(String[] actions, String action) {
	for(String a : actions) {
		if(action.equals(a))
			return true;
	}
	return false;
}

Edited August 10, 2013 by Cory

[lennon]

noob i own you anyday