wyvern.lib.commands
Class AtmosphereCommands

java.lang.Object
  wyvern.lib.commands.AtmosphereCommands

All Implemented Interfaces:

Command

public class AtmosphereCommands

extends java.lang.Object

implements Command

This class handles performing standard atmospheres.

Atmospheres come in several varieties:

• those that take no target (e.g. "blush", "sigh")
• those that can optionally act on an adjacent target ("shake")
• those that can optionally act on a visible target ("bow")
• those that require an adjacent target ("kick")
• those that require a visible target ("peer")
  Those that take a visible target act within a short range that's likely to be valid for both the agent and the target. The range is based on the maximum viewport size allowed for the game.

  Version:

  1.0, Aug 20, 1997

  Author:

  Steve Yegge

  Method Summary

  CommandEvent	createEvent(CommandEvent event) Creates a CommandEvent that encapsulates all the state necessary to perform the command.
  CommandEvent	createEvent(CommandEvent event, Atmospheres atmo) Creates an event with the specified Atmospheres object.
  boolean	execute(CommandEvent event) Implements Command.execute()
  static AtmosphereCommands	getImpl()
  void	handleAdjacent(Monster agent, java.lang.String name, java.lang.String verb, java.lang.String gender, CommandEvent event) Sets up the messages for a adjacent atmosphere.
  void	handleSolo(Monster agent, java.lang.String name, java.lang.String verb, java.lang.String gender, CommandEvent event) Sets up the messages for a solo atmosphere.
  void	handleVisible(Monster agent, java.lang.String name, java.lang.String verb, java.lang.String gender, CommandEvent event) Sets up the messages for a visible atmosphere.
  boolean	knowsCommand(java.lang.String command) Returns true if this Command wants to handle the command.
  boolean	printAtmospheres(CommandEvent event) Prints a list of all available atmospheres to the agent.

  Methods inherited from class java.lang.Object

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

  Method Detail

  getImpl

  public static AtmosphereCommands getImpl()

  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 event)

  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:

  event - 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.

  createEvent

  public CommandEvent createEvent(CommandEvent event,
                                  Atmospheres atmo)

  Creates an event with the specified Atmospheres object.

  Parameters:

  atmo - the Atmospheres object that knows what Atmospheres we consider valid for this event.

  handleSolo

  public void handleSolo(Monster agent,
                         java.lang.String name,
                         java.lang.String verb,
                         java.lang.String gender,
                         CommandEvent event)

  Sets up the messages for a solo atmosphere.

  Parameters:

  agent - the agent

  name - agent.getName()

  verb - the atmosphere

  gender - agent's gender pronoun ("his", "her" or "its")

  event - the event

  Returns:

  sets messages in the event: "agent-msg", "target-msg"

  handleAdjacent

  public void handleAdjacent(Monster agent,
                             java.lang.String name,
                             java.lang.String verb,
                             java.lang.String gender,
                             CommandEvent event)

  Sets up the messages for a adjacent atmosphere.

  Parameters:

  agent - the agent

  name - agent.getName()

  verb - the atmosphere

  gender - agent's gender pronoun ("his", "her" or "its")

  event - the event

  Returns:

  sets messages in the event: "agent-msg", "target-msg", "other-msg"

  handleVisible

  public void handleVisible(Monster agent,
                            java.lang.String name,
                            java.lang.String verb,
                            java.lang.String gender,
                            CommandEvent event)

  Sets up the messages for a visible atmosphere.

  Parameters:

  agent - the agent

  name - agent.getName()

  verb - the atmosphere

  gender - agent's gender pronoun ("his", "her" or "its")

  event - the event

  Returns:

  sets messages in the event: "agent-msg", "target-msg", "other-msg"

  execute

  public boolean execute(CommandEvent event)

  Implements Command.execute()

  Specified by:

  execute in interface Command

  Parameters:

  event - the CommandEvent to execute

  Returns:

  true if the event completed successfully, else false.

  See Also:

  Command.execute(wyvern.lib.CommandEvent)

  printAtmospheres

  public boolean printAtmospheres(CommandEvent event)

  Prints a list of all available atmospheres to the agent.