ihs.apcs.spacebattle.commands

Class ShipCommand

java.lang.Object

ihs.apcs.spacebattle.commands.ShipCommand

Direct Known Subclasses:

AllStopCommand, BrakeCommand, CloakCommand, CollectCommand, DeployLaserBeaconCommand, DeploySpaceMineCommand, DestroyAllLaserBeaconsCommand, EjectCommand, FireTorpedoCommand, IdleCommand, LowerEnergyScoopCommand, RadarCommand, RaiseShieldsCommand, RepairCommand, RotateCommand, ScanCommand, SteerCommand, ThrustCommand, WarpCommand

public abstract class ShipCommand
extends java.lang.Object

Since:

0.1

Constructor Summary

Constructors

Constructor and Description
ShipCommand()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(ShipCommand other)
static boolean	executesImmediately() Returns true if the Command executes as soon as it is processed in the queue and does not delay for any period of time.
static int	getInitialEnergyCost() Gets the one-time energy cost to initiate this command.
java.util.ArrayList<java.lang.Object>	getMessage()
abstract java.lang.String	getName()
static int	getOngoingEnergyCost() Gets the energy cost per second of this command.
static boolean	isBlocking() Returns true if the Command will stop other commands from processing.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShipCommand

public ShipCommand()

Method Detail

getName

public abstract java.lang.String getName()

getInitialEnergyCost

public static int getInitialEnergyCost()

Gets the one-time energy cost to initiate this command.

Returns:

the amount of energy consumed by initiating this command

getOngoingEnergyCost

public static int getOngoingEnergyCost()

Gets the energy cost per second of this command.

Returns:

the amount of energy consumed per second while this command is executing

isBlocking

public static boolean isBlocking()

Returns true if the Command will stop other commands from processing. (default true)

Returns:

true if the command blocks (default).

Since:

1.1

executesImmediately

public static boolean executesImmediately()

Returns true if the Command executes as soon as it is processed in the queue and does not delay for any period of time. (default false) All commands which execute immediately are blocking commands; however, since they don't delay, there is not much impact to consider besides energy costs.

Returns:

false by default

Since:

1.1

getMessage

public java.util.ArrayList<java.lang.Object> getMessage()
                                                 throws java.lang.IllegalArgumentException,
                                                        java.lang.IllegalAccessException

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

equals

public boolean equals(ShipCommand other)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object