com.swath.cmd

Class TakeLeaveColonists

java.lang.Object

com.swath.Info

com.swath.cmd.TakeLeaveColonists

All Implemented Interfaces:

CommandIfc

public final class TakeLeaveColonists
extends Info

Take or leave colonists on the current planet.
Prompts: Planet prompt

Since:

SWATH 1.3

See Also:

TakeLeaveProducts, TakeLeaveFighters, TakeLeaveShields, TakeLeaveCredits

Method Summary

Modifier and Type	Method and Description
static void	exec(int colonists, int type) Take or leave colonists on the current planet.
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(int colonists,
                        int type)
                 throws java.lang.Exception

Take or leave colonists on the current planet. Positive number of colonists means taking and negative number means leaving.

Parameters:

colonists - The number of colonists to take/leave.

type - The type of product to take/leave colonists from/at.

Throws:

java.lang.Exception

Since:

SWATH 1.3

See Also:

Swath.FUEL_ORE, Swath.ORGANICS, Swath.EQUIPMENT

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.