Class FlareCommand

java.lang.Object

VASSAL.command.Command

VASSAL.command.FlareCommand

public class FlareCommand
extends Command

A Command for sending Flare actions to other clients

Constructor Summary

Constructors

Constructor	Description
FlareCommand(Flare flare)

Method Summary

Modifier and Type	Method	Description
protected void	executeCommand()	Executes the command (starts a Flare at the specified location)
Point	getClickPoint()
String	getId()
int	getValue()
protected Command	myUndoCommand()	If the action can be undone, return a Command that performs the inverse action.

Methods inherited from class Command

append, execute, getDetails, getSubCommands, getUndoCommand, isAtomic, isLoggable, isNull, isNullOrContainsOnly, stripSubCommands, toString

Modifier and Type	Method	Description
Command	append(Command c)	Append a subcommand to this Command.
void	execute()	Execute this command by first invoking Command.executeCommand(), then invoking itself recursively on all subcommands.
String	getDetails()	Detailed information for toString()
Command[]	getSubCommands()
Command	getUndoCommand()
protected boolean	isAtomic()	Return true if this command has no sub-commands attached to it (other than null commands).
boolean	isLoggable()
boolean	isNull()
boolean	isNullOrContainsOnly(Class<?> target)	Return true if this Command is a NullCommand or only contains Null Commands or commands of the same type as target
void	stripSubCommands()	Remove all subcommands.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FlareCommand

public FlareCommand(Flare flare)

Parameters:

flare - Flare object to define our new action from

Method Details

executeCommand

protected void executeCommand()

Executes the command (starts a Flare at the specified location)

Specified by:

executeCommand in class Command

myUndoCommand

protected Command myUndoCommand()

Description copied from class: Command

If the action can be undone, return a Command that performs the inverse action. The Command returned should only undo Command.executeCommand(), not the actions of subcommands

Specified by:

myUndoCommand in class Command

Returns:

null - no undo needed for Flare commands

getValue

public int getValue()

Returns:

0

getClickPoint

public Point getClickPoint()

Returns:

specified flare location on map

getId

public String getId()

Returns:

unique ID of the Flare object that this flare command is intended to activate