ExampleScript1 (SWATH JavaDoc)

java.lang.Object
- com.swath.UserDefinedScript
- - ExampleScript1

```
public class ExampleScript1
extends UserDefinedScript
```
This is my first SWATH script. It moves your ship to a sector and lands on a planet there.

Since:

SWATH 1.3

Constructor Summary

Constructors
Constructor and Description

ExampleScript1()

Constructors
Constructor and Description
`ExampleScript1()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`static void`	`exec(int sector, Planet planet)` Moves your ship to a sector and lands on a planet there.
`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.
`boolean`	`initScript()` Called by the framework to initialise the script. You should override this method to make your own initialisation.
`boolean`	`runScript()` Called by the framework to run the script. You should override this method to define the script body.

Methods inherited from class com.swath.UserDefinedScript
atPrompt, beginTurboCycle, endTurboCycle, execInstance, getClassName, getParams, getResource, initInstance, onEvent, postEvent, printTrace, printTrace, registerParam, repeatTurboCycle, showUserParamWindow, showUserParamWindow, sleep

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

- Constructor Detail
  - ExampleScript1
```
public ExampleScript1()
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Description copied from class: UserDefinedScript
    
    Called by the framework to get the name of the script.
    You should override this method.
    
    Overrides:
    
    getName in class UserDefinedScript
    
    Returns:
    
    The script name.
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from class: UserDefinedScript
    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..."
    Overrides:
    
    getDescription in class UserDefinedScript
    
    Returns:
    
    The script description.
  - initScript
```
public boolean initScript()
                   throws java.lang.Exception
```
    Description copied from class: UserDefinedScript
    
    Called by the framework to initialise the script.
    You should override this method to make your own initialisation.
    
    Overrides:
    
    initScript in class UserDefinedScript
    
    Returns:
    
    true if the initialisation was successful, otherwise false.
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    UserDefinedScript.atPrompt(int), UserDefinedScript.showUserParamWindow(Panel,int,int), UserDefinedScript.showUserParamWindow(JPanel,int,int)
  - runScript
```
public boolean runScript()
                  throws java.lang.Exception
```
    Description copied from class: UserDefinedScript
    
    Called by the framework to run the script.
    You should override this method to define the script body.
    
    Overrides:
    
    runScript in class UserDefinedScript
    
    Returns:
    
    true if the script finished correctly, otherwise false.
    
    Throws:
    
    java.lang.Exception
  - endScript
```
public void endScript(boolean finished)
               throws java.lang.Exception
```
    Description copied from class: UserDefinedScript
    
    Called by the framework when the script is finished.
    You can override this method to clean up after the script if needed.
    
    Overrides:
    
    endScript in class UserDefinedScript
    
    Parameters:
    
    finished - true if the script finished correctly or false if the script was interrupted in some way.
    
    Throws:
    
    java.lang.Exception
  - exec
```
public static void exec(int sector,
                        Planet planet)
                 throws java.lang.Exception
```
    Moves your ship to a sector and lands on a planet there.
    
    Parameters:
    
    sector - The sector to move to.
    
    planet - The planet to land on.
    
    Throws:
    
    java.lang.Exception

Class ExampleScript1

Constructor Summary

Method Summary

Methods inherited from class com.swath.UserDefinedScript

Methods inherited from class java.lang.Object

Constructor Detail

ExampleScript1

Method Detail

getName

getDescription

initScript

runScript

endScript

exec