cmd
Class Use

java.lang.Object
  extended by cmd.Use
All Implemented Interfaces:
Command

public class Use
extends java.lang.Object
implements Command

Use Uses an item in the inventory. For example, if you have a gun, it will shoot the gun. Some items have a limited number of uses.


Constructor Summary
Use()
           
 
Method Summary
 void construct(java.lang.String[] params)
          construct is called when the Command is created.
 void exec(Player p)
          exec is the main method of the command.
 void setDir(java.lang.String dir)
           
 void setName(java.lang.String itemToBeUsed)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Use

public Use()
Method Detail

exec

public void exec(Player p)
Description copied from interface: Command
exec is the main method of the command. exec is called by executeCommand in the core.Game class. Everything that should happen when you execute the command, besides the initialisation of what the command should execute on, should happen in this method.

Specified by:
exec in interface Command
Parameters:
p - is the main player. The player is passed to exec because a lot of useful info, such as the current room, are attached to the Player class.

construct

public void construct(java.lang.String[] params)
Description copied from interface: Command
construct is called when the Command is created. construct should parse the params array, and get relevant information from it. For example, if the command was "move e", the params array would contain "e", so the construct command should set an instance variable dir that has "e" as its value. Then, when exec is called, it can use this information.

Specified by:
construct in interface Command

setDir

public void setDir(java.lang.String dir)

setName

public void setName(java.lang.String itemToBeUsed)

toString

public java.lang.String toString()
Specified by:
toString in interface Command
Overrides:
toString in class java.lang.Object
Returns:
The description of the command created for the Help command to print when the player types "help your_cmd_name".