The scripting system of BatClient is based upon BeanShell scripting. Fore more information about BeanShell visit http://www.beanshell.org. Scripts allow you to write small programs for particular events in the game. It is possible to call scripts from triggers and macros to perform whatever you write them to do. It is also possible to write scripts that are called when the client is started. You could for example write a particular script to generate a set of triggers or macros and distribute it as an add-on. Scripts are put into the user.dir/batclient/script folder and they are autoloaded when the client starts up or when you use the /scriptreload feature.

A script is basically a text file that include BeanShell/Java code. You can read more about the particular syntax of the beanshell scripts at the beanshell website. It supports both loosly written script code and full blown java code. You can write your scripts by using your favorite text editor and placing the files into the user.dir/batclient/scripts folder before you start the client or issue a /scriptreload command. You can also use the internal script editor inside the client to write and manage your scripts. The /scriptreload command will first remove every trigger and macro which are loaded through scripts before reloading all new scripts.

The following commands can be used to manage your scripts:
/scriptlist
/scriptreload
/scriptbootup

The scripts are called from different places in the client and you can also call on a script manually from the commandline, triggers or macros. When a script is called manually the "run()" method inside the script will be evaluated as default. To call a script you use the $ character infront of the script name. You can also call a particular method inside the script by adding .methodname to the scriptname. For example: $myScript.myMethod

Every script must define the SCRIPT_NAME variable. It is what will identify the script inside the client. This variable must be set to a unique string. For example:
SCRIPT_NAME = "myUniqueScript";

It is possible to define the SCRIPT_ON variable if you wish to turn a script off temporarily. If the variable is not defined the script is default on. To turn a script off define the variable as: "SCRIPT_ON = false;"

Script variables

Before a method in the script is evaluated certain variables will be set automatically. Some variables are only available for certain methods (described below) and some variables are global and can be accessed inside any of the methods described below. Javadoc for the interface is available in the help menu.

• clientGUI
  This is a reference to the interface for the client which contains methods for manipulating certain available components.
• triggerManager
  A reference to the object that handles all the triggers in the game.
  com.mythicscape.batclient.interfaces.TriggerManager
• macroManager
  A reference to the object that handles all the macros in the game.
  com.mythicscape.batclient.interfaces.MacroManager
• scriptManager
  A reference to the object that handles all the scripts in the game.
  com.mythicscape.batclient.interfaces.ScriptManager
• gvars
  A reference to the object that handles all global variables.
  com.mythicscape.batclient.interfaces.Global
• net
  A reference to the object that handles all networking.
  com.mythicscape.batclient.interfaces.Net
• vars
  The "vars" variable is set on scripts before they are called if the script is runned after a trigger has matched a regexp pattern. The entries in the ArrayList will match towards the matches in the regexp. For example the first match in the regexp which is %1 in the pattern will be at index 1 of the ArrayList. To get the value matching %1 you use "vars.get(1);". Index 0 (%0) in the ArrayList always match the entire received String. NOTE that this variable is not automatically cleared. It is only overwritten in a script when a new regexp match occurs.
  java.util.ArrayList
• argument
  The "argument" variable is a reference to the argument that was given to the script when it was called. For example if you call the script with: "$myScript.someMethod a b c" the argument will be "a b c".
  java.lang.String

The following methods can be defined to perform different things inside the client. The run() method is the standard method that will be called if the script is executed manually. You can also define your own methods and call them yourself. These methods listed here are called by the actual client when different events occurs.

• void run()
  This method is called when the script is evaluated from the commandline, a trigger or a macro. The variable argument is a reference to any arguments given when running the script. For example if you call the script from the commandline as: "$test_script arg1 arg2 arg3". The argument string will be "arg1 arg2 arg3". It is then up to your script to parse the arguments as you see fit.
• void bootup()
  This method is called when the client boots up (starts up). When you add a script like this you will have to call /scriptbootup it to perform whatever it is supposed to do. Remember that when you have added or changed a script you have to call /scriptreload to get all the changed loaded.
• void connect()
  This method is called when the client successfully connects to the game server.
• void disconnect()
  This method is called when the client is disconnected from the game server.
• String trigger()
  When you want to create a totally custom trigger you can use a script that has this method defined. The script will then be called prior to any other normal triggers that has been defined and you can handle all the parsing of the input yourself. The text that is received is stored in the "argument" variable. This method should return a String value. If null is returned, the script will abort all other triggers and no text will be printed into the text window at all. If a defined String is returned, the text will be sent onwards to all other triggers and if nothing else prevents it, the text will be printed into the text window.