wyvern.lib.commands
Class TalkCommand

java.lang.Object
  wyvern.lib.commands.TalkCommand

All Implemented Interfaces:

BuiltInCommand, Command

public class TalkCommand

extends java.lang.Object

implements BuiltInCommand

This class implements the command "talk" by looking around for a monster that has a "talker" property.

Version:

1.0, Apr 20, 1998

Author:

Steve Yegge

Nested Class Summary

class

TalkCommand.TalkEvent This class encapsulates a talk request, so that onlookers can respond when the user tries to "talk" to someone (e.g. an NPC).

Method Summary

void	addCommands(java.util.Map commands, 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 new TalkEvent
boolean	execute(CommandEvent e) Executes the specified CommandEvent.
static TalkCommand	getImpl()
boolean	handleDefaultResponse(CommandEvent event, Commandable agent, GameObject target) Looks for a "default-response" property on the monster.
boolean	knowsCommand(java.lang.String command) Returns true if this Command wants to handle the command.
void	wakeTarget(GameObject target) Wakes up the target if they're chatted to/at.

Methods inherited from class java.lang.Object

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

Method Detail

getImpl

public static TalkCommand getImpl()

addCommands

public void addCommands(java.util.Map commands,
                        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:

commands - 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 command)

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:

command - the entire command string, including arguments

Returns:

true if we want to handle the command

createEvent

public CommandEvent createEvent(CommandEvent e)

Creates a new TalkEvent

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)

Description copied from interface: Command

Executes the specified CommandEvent. The CommandEvent contains all the parameters and state required to execute the command; the parameters have been filtered through hook objects, so they may not be the same as when the event was created.

Specified by:

execute in interface Command

Parameters:

e - the CommandEvent to execute

Returns:

true if the event completed successfully, else false.

handleDefaultResponse

public boolean handleDefaultResponse(CommandEvent event,
                                     Commandable agent,
                                     GameObject target)

Looks for a "default-response" property on the monster.

Returns:

true if we found a response

wakeTarget

public void wakeTarget(GameObject target)

Wakes up the target if they're chatted to/at.