[Important] OSBot golden scripting rule: Exception handling in OSBot

[Maxi]

Hi everyone,

 

It has come to my attention that it's not clear for everyone how to handle exception in OSBot scripts. Various pieces of code in the OSBot client throw InterruptedExceptions. Everywhere where you have a try-catch block you have to make sure you add specific clause to catch InterruptedExceptions in which you then have to throw, in front of any other catch clause. If you're only adding try-catch blocks to catch the InterruptedException, then make sure you are just adding the throws statement to the method signature and remove your try-catch block entirely.

 

The reason this is important is because the client uses interrupted exceptions to switch behaviour, for example when the bot will switch from the script to a random executor, or when you pause your script.

 

Here is an example:

 
    /**
     * Gets called recursively on the bot's main thread.
     *
     * @return The timeout to sleep after running one loop cycle.
     */
    @Override
    public int onLoop() throws InterruptedException {
        try {
            scan();
            switch (state) {
                case IDLE:
                    return 100 + gRandom(100, 50);
                case STEAL:
                    return steal();
                case TO_BANK:
                    return toBank();
                case BANK:
                    return bank();
                case TO_STALL:
                    return toStall();
            }
            return 20 + gRandom(100, 100);  
        } catch (InterruptedException e) { // <---- VERY IMPORTANT ----> \\
            throw e;                       // <---- VERY IMPORTANT ----> \\
        } catch (Exception e) {
            e.printStackTrace();
            return 100 + gRandom(200, 100);
        }
    }

[shockdz]

People who didn't know this yet probably script in Notepad. Thanks for this Maxi, it'll help out some people.

[GoldenGates]

People who didn't know this yet probably script in Notepad. Thanks for this Maxi, it'll help out some people.

I script with pencil and paper...and people probably didn't think this was necessary.

[Aeterna]

Figured throwing the exception was enough - thanks.

[Jack]

What happens to your script if you don't do this?

[Rick]

What happens to your script if you don't do this?

 

it will get stuck.

 

(right)

[pwnd]

I don't really understand why you would throw an exception that is already being thrown.  You should probably add code there to handle the exception.... rather than just throw it again.  

 

People who didn't know this yet probably script in Notepad.  

People who can use just a text editor to program are probably above you, just sayin'.

Edited July 16, 2013 by pwnd

[DJay]

I don't really understand why you would throw an exception that is already being thrown.  You should probably add code there to handle the exception.... rather than just throw it again.  

 

People who didn't know this yet probably script in Notepad.  

People who can use just a text editor to program are probably above you, just sayin'.

 

Haha, I remember when I was into RSPS coding I used to program stuff with a pencil in paper when I was bored in classes. Writing scripts is a bit more complicated for me though. :P