wyvern.lib.commands
Class QuitCommand

java.lang.Object
  wyvern.lib.commands.QuitCommand

All Implemented Interfaces:

BuiltInCommand, Command

public class QuitCommand

extends java.lang.Object

implements BuiltInCommand

User wants to bail. You can't veto this command, since it's a bad idea to prevent players from quitting - they could run into a bug where quitting is the only way out. Instead, get on the quitPostHook and do your cleanup there.

Version:

1.0, Sep 01, 1997

Author:

Steve Yegge

Method Summary

void	addCommands(java.util.Map cmds, CommandList list) Tells the Command to add the commands that it wants to implement into the passed data structure.
CommandEvent	createEvent(CommandEvent e) Creates a CommandEvent that encapsulates all the state necessary to perform the command.
boolean	execute(CommandEvent e) Implements Command.execute().
static QuitCommand	getImpl()
boolean	knowsCommand(java.lang.String cmd) Returns true if this Command wants to handle the command.

Methods inherited from class java.lang.Object

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

Method Detail

getImpl

public static QuitCommand getImpl()

addCommands

public void addCommands(java.util.Map cmds,
                        CommandList list)

Description copied from interface: BuiltInCommand

Tells the Command to add the commands that it wants to implement into the passed data structure.

Specified by:

addCommands in interface BuiltInCommand

Parameters:

cmds - a Map whose keys are commands, and whose values are Commands that handle those commands.

list - the CommandList the Command is being added to.

knowsCommand

public boolean knowsCommand(java.lang.String cmd)

Description copied from interface: Command

Returns true if this Command wants to handle the command. The Command can examine the arguments and determine that it doesn't actually understand the command, in which case it should return false.

This method exists to allow more than one game object to implement the same command verb, but with different expected arguments.

If two objects register for the same command and the same arguments, the object that was registered most recently gets to handle at the command.

Specified by:

knowsCommand in interface Command

Parameters:

cmd - the entire command string, including arguments

Returns:

true if we want to handle the command

createEvent

public CommandEvent createEvent(CommandEvent e)

Description copied from interface: Command

Creates a CommandEvent that encapsulates all the state necessary to perform the command. A well-designed CommandEvent exposes all of its "properties" so that hook objects can modify its behavior. For instance, many commands result in some sort of message being sent back to the client. The message should be among the properties that hooks can override.

This method is called by the kernel. The kernel passes the event to the pre-hook, then calls Command.execute() (below) to execute the event, and finally calls the post-hook.

Specified by:

createEvent in interface Command

Parameters:

e - a "blank" CommandEvent containing only the command text and the agent who's performing the command. This initial event is created by the originator of the event (e.g. the AI or player's command preprocessor).

Returns:

a CommandEvent subclass encapsulating this command's execution parameters and state. It should copy in the fields from the passed-in event.

execute

public boolean execute(CommandEvent e)

Implements Command.execute(). You can't veto the QuitCommand - if you need to do some sort of cleanup when a player quits, get on the quitPostHook.

Specified by:

execute in interface Command

Parameters:

e - the CommandEvent to execute

Returns:

true if the event completed successfully, else false.