UserDefinedScript (SWATH JavaDoc)

java.lang.Object
- com.swath.UserDefinedScript

Direct Known Subclasses:

ExampleScript1, ExampleScript2, ExampleScript3, ExampleScript4, ExampleScript5, ExampleScript6, ExampleScript7, ExampleScript8
```
public abstract class UserDefinedScript
extends java.lang.Object
```
User Defined Script base class.

Since:

SWATH 1.3

Constructor Summary

Constructors
Constructor and Description

UserDefinedScript()
Constructor.

Constructors
Constructor and Description
`UserDefinedScript()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`atPrompt(int validPrompts)` Checks if you are at any of the valid prompts.
`void`	`beginTurboCycle()` This marks the start of a turbo cycle.
`void`	`endScript(boolean finished)` Called by the framework when the script is finished. You can override this method to clean up after the script if needed.
`void`	`endTurboCycle()` This marks the end of a turbo cycle.
`void`	`execInstance()` Executes a script instance. Should only be called from static `exec()` methods.
`java.lang.String`	`getClassName()` Gets the class name.
`java.lang.String`	`getDescription()` Called by the framework to get the description of the script. You should override this method to provide a script description. The script description can be an URL to a HTML page or file.
`java.lang.String`	`getName()` Called by the framework to get the name of the script. You should override this method.
`java.util.Enumeration`	`getParams()` Gets the script parameters.
`java.net.URL`	`getResource(java.lang.String resource)` Finds a resource with a given name.
`void`	`initInstance()` Initialises a script instance. Should only be called from static `exec()` methods.
`boolean`	`initScript()` Called by the framework to initialise the script. You should override this method to make your own initialisation.
`void`	`onEvent(EventIfc event)` This method is called for each posted event. You can override this method to handle events. You can execute commands during the event handling and they will all be executed in one sequence between normal script commands.
`void`	`postEvent(UserDefinedEvent event)` This method posts an event in the SWATH event queue.
`void`	`printTrace(java.lang.Exception e)` Print an exception and the complete stack trace in the SWATH console window.
`void`	`printTrace(java.lang.String text)` Print trace text in the SWATH console window.
`void`	`registerParam(Parameter param)` This method is used to register a script parameter.
`void`	`repeatTurboCycle()` This method will repeat the recorded turbo cycle.
`boolean`	`runScript()` Called by the framework to run the script. You should override this method to define the script body.
`boolean`	`showUserParamWindow(javax.swing.JPanel panel, int width, int height)` Displays a Swing frame window for script parameter input.
`boolean`	`showUserParamWindow(java.awt.Panel panel, int width, int height)` Displays an AWT frame window for script parameter input.
`void`	`sleep(long ms)` Wait and sleep for a while.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UserDefinedScript
```
public UserDefinedScript()
```
    Constructor.
- Method Detail
  - getClassName
```
public final java.lang.String getClassName()
```
    Gets the class name.
    
    Returns:
    
    The script class name.
    
    Since:
    
    SWATH 1.3
  - registerParam
```
public final void registerParam(Parameter param)
                         throws ScriptException
```
    This method is used to register a script parameter.
    
    Parameters:
    
    param - The parameter to register.
    
    Throws:
    
    ScriptException - If no more parameters could be added.
    
    Since:
    
    SWATH 1.3
  - getParams
```
public final java.util.Enumeration getParams()
```
    Gets the script parameters.
    
    Returns:
    
    The script parameters.
    
    Since:
    
    SWATH 1.3
  - initInstance
```
public final void initInstance()
                        throws ScriptException,
                               java.lang.Exception
```
    Initialises a script instance.
    Should only be called from static exec() methods.
    
    Throws:
    
    ScriptException - If the script initialisation fails for some reason.
    
    java.lang.Exception
    
    Since:
    
    SWATH 1.6.2
    
    See Also:
    
    execInstance()
  - execInstance
```
public final void execInstance()
                        throws ScriptException,
                               java.lang.Exception
```
    Executes a script instance.
    Should only be called from static exec() methods.
    
    Throws:
    
    ScriptException - If the script execution fails for some reason.
    
    java.lang.Exception
    
    Since:
    
    SWATH 1.6.2
    
    See Also:
    
    initInstance()
  - atPrompt
```
public final boolean atPrompt(int validPrompts)
                       throws java.lang.Exception
```
    Checks if you are at any of the valid prompts.
    
    Parameters:
    
    validPrompts - The valid prompts. (Combine several prompts with logical OR)
    
    Returns:
    
    true if you are at a valid prompt, otherwise false.
    
    Throws:
    
    java.lang.Exception
    
    Since:
    
    SWATH 1.3
    
    See Also:
    
    Swath.NO_PROMPT, Swath.COMMAND_PROMPT, Swath.COMPUTER_PROMPT, Swath.PLANET_PROMPT, Swath.CITADEL_PROMPT, Swath.CORP_PROMPT, Swath.STARDOCK_PROMPT, Swath.ALL_PROMPTS
  - sleep
```
public final void sleep(long ms)
```
    Wait and sleep for a while.
    
    Parameters:
    
    ms - The time to sleep in milliseconds.
    
    Since:
    
    SWATH 1.5
  - getResource
```
public final java.net.URL getResource(java.lang.String resource)
```
    Finds a resource with a given name. The search is done using the class path.
    
    Parameters:
    
    resource - The name of the wanted resource.
    
    Returns:
    
    The URL to the wanted resource or null if not found.
    
    Since:
    
    SWATH 1.5
  - beginTurboCycle
```
public final void beginTurboCycle()
                           throws java.lang.Exception
```
    This marks the start of a turbo cycle. All commands you execute after calling this method will be recorded until you call the endTurboCycle() method.
    
    Throws:
    
    java.lang.Exception
    
    Since:
    
    SWATH 2.0
    
    See Also:
    
    endTurboCycle(), repeatTurboCycle()
  - endTurboCycle
```
public final void endTurboCycle()
                         throws java.lang.Exception
```
    This marks the end of a turbo cycle. The recoding of commands will now stop. Make sure you end the cycle at the same place and state as it began. Call the repeatTurboCycle() method to repeat the cycle.
    
    Throws:
    
    java.lang.Exception
    
    Since:
    
    SWATH 2.0
    
    See Also:
    
    beginTurboCycle(), repeatTurboCycle()
  - repeatTurboCycle
```
public final void repeatTurboCycle()
                            throws java.lang.Exception
```
    This method will repeat the recorded turbo cycle. The complete command sequence will be sent directly to the TWGS game server for speed. Call this method several times to perform multiple cycles. Every cycle will be exactly the same, so if you need to change anything, record a new cycle. You can do anything between the cycles, but you need to make sure you return to the same place and state when you decide to repeat the next cycle.
    
    Throws:
    
    java.lang.Exception
    
    Since:
    
    SWATH 2.0
    
    See Also:
    
    beginTurboCycle(), endTurboCycle()
  - postEvent
```
public final void postEvent(UserDefinedEvent event)
```
    This method posts an event in the SWATH event queue. Everyone that listens for this event will be notified.
    
    Parameters:
    
    event - The event to post.
    
    Since:
    
    SWATH 1.7
  - printTrace
```
public final void printTrace(java.lang.String text)
                      throws java.lang.Exception
```
    Print trace text in the SWATH console window.
    
    Parameters:
    
    text - The text to print.
    
    Throws:
    
    java.lang.Exception
    
    Since:
    
    SWATH 1.7
  - printTrace
```
public final void printTrace(java.lang.Exception e)
                      throws java.lang.Exception
```
    Print an exception and the complete stack trace in the SWATH console window.
    
    Parameters:
    
    e - The exception to print.
    
    Throws:
    
    java.lang.Exception
    
    Since:
    
    SWATH 1.7
  - showUserParamWindow
```
public final boolean showUserParamWindow(java.awt.Panel panel,
                                         int width,
                                         int height)
                                  throws java.lang.Exception
```
    Displays an AWT frame window for script parameter input.
    
    Parameters:
    
    panel - The user defined panel that holds all components that should be displayed in the client area of the window.
    
    width - The width of the window.
    
    height - The height of the window.
    
    Returns:
    
    true if the user choosed to start the script, otherwise false.
    
    Throws:
    
    java.lang.Exception
    
    Since:
    
    SWATH 1.4
    
    See Also:
    
    Tools.createPanel(), showUserParamWindow(JPanel,int,int)
  - showUserParamWindow
```
public final boolean showUserParamWindow(javax.swing.JPanel panel,
                                         int width,
                                         int height)
                                  throws java.lang.Exception
```
    Displays a Swing frame window for script parameter input.
    
    Parameters:
    
    panel - The user defined panel that holds all components that should be displayed in the client area of the window.
    
    width - The width of the window.
    
    height - The height of the window.
    
    Returns:
    
    true if the user choosed to start the script, otherwise false.
    
    Throws:
    
    java.lang.Exception
    
    Since:
    
    SWATH 1.5
    
    See Also:
    
    Tools.createJPanel(), showUserParamWindow(Panel,int,int)
  - getName
```
public java.lang.String getName()
```
    Called by the framework to get the name of the script.
    You should override this method.
    
    Returns:
    
    The script name.
    
    Since:
    
    SWATH 1.3
  - getDescription
```
public java.lang.String getDescription()
```
    Called by the framework to get the description of the script.
    You should override this method to provide a script description.
    
    The script description can be an URL to a HTML page or file. It can also be normal HTML text or plain text.
    
    By default, a file named ScriptClass.html or ScriptClass.txt is used if found.
    
    Examples:
    - "http://www.swath.net/Help.html"
    - "file:///C:/HelpDir/Help.html"
    - "<html>This <b>script</b> will...</html>"
    - "This script will..."
    Returns:
    
    The script description.
    
    Since:
    
    SWATH 1.5
  - initScript
```
public boolean initScript()
                   throws java.lang.Exception
```
    Called by the framework to initialise the script.
    You should override this method to make your own initialisation.
    
    Returns:
    
    true if the initialisation was successful, otherwise false.
    
    Throws:
    
    java.lang.Exception
    
    Since:
    
    SWATH 1.3
    
    See Also:
    
    atPrompt(int), showUserParamWindow(Panel,int,int), showUserParamWindow(JPanel,int,int)
  - runScript
```
public boolean runScript()
                  throws java.lang.Exception
```
    Called by the framework to run the script.
    You should override this method to define the script body.
    
    Returns:
    
    true if the script finished correctly, otherwise false.
    
    Throws:
    
    java.lang.Exception
    
    Since:
    
    SWATH 1.3
  - endScript
```
public void endScript(boolean finished)
               throws java.lang.Exception
```
    Called by the framework when the script is finished.
    You can override this method to clean up after the script if needed.
    
    Parameters:
    
    finished - true if the script finished correctly or false if the script was interrupted in some way.
    
    Throws:
    
    java.lang.Exception
    
    Since:
    
    SWATH 1.3
  - onEvent
```
public void onEvent(EventIfc event)
             throws java.lang.Exception
```
    This method is called for each posted event.
    You can override this method to handle events.
    
    You can execute commands during the event handling and they will all be executed in one sequence between normal script commands. Make sure you return to the same place and state afterwards.
    
    Parameters:
    
    event - The event.
    
    Throws:
    
    java.lang.Exception
    
    Since:
    
    SWATH 2.0

Class UserDefinedScript

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserDefinedScript

Method Detail

getClassName

registerParam

getParams

initInstance

execInstance

atPrompt

sleep

getResource

beginTurboCycle

endTurboCycle

repeatTurboCycle

postEvent

printTrace

printTrace

showUserParamWindow

showUserParamWindow

getName

getDescription

initScript

runScript

endScript

onEvent