com.swath.cmd
Class LandOnStarDock

java.lang.Object
  com.swath.Info
      com.swath.cmd.SwathCommand
          com.swath.cmd.LandOnStarDock

All Implemented Interfaces:

CommandIfc

public final class LandOnStarDock

extends com.swath.cmd.SwathCommand

Land on the StarDock.
Prompts: Command prompt

Since:

SWATH 1.4

See Also:

LeaveStarDock

Method Summary

static void	exec() Land on the StarDock.
static void	exec(boolean removeLimpetIfAny) Land on the StarDock.
java.lang.String	getClassName() Gets the command class name.
java.lang.String	getName() Gets the name of the command.
java.util.Enumeration	getParams() Gets the command parameters.
boolean	initCommand()
boolean	isInternal() Indicates if this is an internal SWATH command or not.
boolean	isUserDefined() Indicates if this command is user defined or not.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

initCommand

public boolean initCommand()
                    throws java.lang.Exception

Throws:

java.lang.Exception

exec

public static void exec()
                 throws java.lang.Exception

Land on the StarDock. Will remove any limpet mines found on the ship.

Throws:

java.lang.Exception

Since:

SWATH 1.4

exec

public static void exec(boolean removeLimpetIfAny)
                 throws java.lang.Exception

Land on the StarDock.

Parameters:

removeLimpetIfAny - true if you want to pay for limpet mine removal in case the ship has one attached or false if you want the script to wait for user input.

Throws:

java.lang.Exception

Since:

SWATH 1.8

isUserDefined

public final boolean isUserDefined()

Description copied from interface: CommandIfc

Indicates if this command is user defined or not.

Specified by:

isUserDefined in interface CommandIfc

Returns:

true if user defined, otherwise false.

getName

public final java.lang.String getName()

Description copied from interface: CommandIfc

Gets the name of the command.

Specified by:

getName in interface CommandIfc

Returns:

The command name.

getClassName

public final java.lang.String getClassName()

Description copied from interface: CommandIfc

Gets the command class name.

Specified by:

getClassName in interface CommandIfc

Returns:

The class name.

getParams

public final java.util.Enumeration getParams()

Description copied from interface: CommandIfc

Gets the command parameters.

Specified by:

getParams in interface CommandIfc

Returns:

The command parameters.

isInternal

public boolean isInternal()

Description copied from interface: CommandIfc

Indicates if this is an internal SWATH command or not.

Specified by:

isInternal in interface CommandIfc

Returns:

true if internal, otherwise false.