com.swath.cmd

Class PlanetWarp

java.lang.Object

com.swath.Info

com.swath.cmd.PlanetWarp

All Implemented Interfaces:

CommandIfc

public final class PlanetWarp
extends Info

Warp the current planet to another sector.
Prompts: Citadel prompt

Since:

SWATH 1.3

See Also:

Move, Transport, TransWarp, PlanetTransport, MoveToNavPoint

Method Summary

Modifier and Type	Method and Description
static void	exec(int sector) Warp the current planet to another sector.
static void	exec(Sector sector) Warp the current planet to another 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

Method Detail

initCommand

public boolean initCommand()
                    throws java.lang.Exception

Throws:

java.lang.Exception

exec

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

Warp the current planet to another sector.

Parameters:

sector - The sector to warp the planet to.

Throws:

java.lang.Exception

Since:

SWATH 1.3

exec

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

Warp the current planet to another sector.

Parameters:

sector - The sector to warp the planet to.

Throws:

java.lang.Exception

Since:

SWATH 1.6

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.