com.swath.cmd
Class AttackTrader

java.lang.Object
  extended bycom.swath.Info
      extended bycom.swath.cmd.SwathCommand
          extended bycom.swath.cmd.AttackTrader
All Implemented Interfaces:
CommandIfc

public final class AttackTrader
extends com.swath.cmd.SwathCommand

Attack a trader.
Prompts: Command prompt

Since:
SWATH 1.4
See Also:
AttackShip

Field Summary
static int ATTACKED
          The trader was attacked but still got fighters/shields left.
static int FLED
          The trader fled to an adjacent sector.
static int KILLED
          The trader was killed and the ship is destroyed.
static int NO_ATTACK
          No attack was made for some reason.
static int PODDED
          The trader left the ship in an escape pod.
 
Method Summary
static int exec(Trader trader)
          Attack a trader with enough fighters to pod him/her and capture the ship.
static int exec(Trader trader, int fighters)
          Attack a trader with a specific amount of fighters.
 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

NO_ATTACK

public static final int NO_ATTACK
No attack was made for some reason.

See Also:
Constant Field Values

ATTACKED

public static final int ATTACKED
The trader was attacked but still got fighters/shields left.

See Also:
Constant Field Values

KILLED

public static final int KILLED
The trader was killed and the ship is destroyed.

See Also:
Constant Field Values

PODDED

public static final int PODDED
The trader left the ship in an escape pod. The ship is now yours.

See Also:
Constant Field Values

FLED

public static final int FLED
The trader fled to an adjacent sector.

See Also:
Constant Field Values
Method Detail

initCommand

public boolean initCommand()
                    throws java.lang.Exception
Throws:
java.lang.Exception

exec

public static int exec(Trader trader,
                       int fighters)
                throws java.lang.Exception
Attack a trader with a specific amount of fighters.

Parameters:
trader - The trader to attack or null to attack the first trader in the sector.
fighters - The amount of fighters to attack with.
Returns:
The result of the attack.
Throws:
java.lang.Exception
Since:
SWATH 1.6
See Also:
NO_ATTACK, ATTACKED, KILLED, PODDED, FLED

exec

public static int exec(Trader trader)
                throws java.lang.Exception
Attack a trader with enough fighters to pod him/her and capture the ship.

Parameters:
trader - The trader to attack or null to attack the first trader in the sector.
Returns:
The result of the attack.
Throws:
java.lang.Exception
Since:
SWATH 1.6
See Also:
NO_ATTACK, ATTACKED, KILLED, PODDED, FLED

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.