com.swath.cmd

Class DropTakeMines

java.lang.Object

com.swath.Info

com.swath.cmd.DropTakeMines

All Implemented Interfaces:

CommandIfc

public final class DropTakeMines
extends Info

Drop/Take mines in the current sector.
Prompts: Command prompt

Since:

SWATH 1.3

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARMID Armid mines.
static int	LIMPET Limpet mines.

Method Summary

Modifier and Type	Method and Description
static void	exec(int type) Just pick up the mines in the current sector.
static void	exec(int type, int mines, int owner) Drop/Take mines in the current sector.
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

Field Detail

ARMID

public static final int ARMID

Armid mines.

See Also:

Constant Field Values

LIMPET

public static final int LIMPET

Limpet mines.

See Also:

Constant Field Values

Method Detail

initCommand

public boolean initCommand()
                    throws java.lang.Exception

Throws:

java.lang.Exception

exec

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

Just pick up the mines in the current sector.

Parameters:

type - The type of mines to pick up: ARMID or LIMPET.

Throws:

java.lang.Exception

Since:

SWATH 1.3

See Also:

ARMID, LIMPET

exec

public static void exec(int type,
                        int mines,
                        int owner)
                 throws java.lang.Exception

Drop/Take mines in the current sector.

Parameters:

type - The type of mines to leave: ARMID or LIMPET.

mines - The number of mines to leave. 0 means only pick up mines.

owner - The owner type of the mines to leave: PERSONAL or CORPORATE.

Throws:

java.lang.Exception

Since:

SWATH 1.3

See Also:

ARMID, LIMPET, Swath.PERSONAL, Swath.CORPORATE

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.