com.planet_ink.coffee_mud.Commands
Class Go

java.lang.Object
  extended by com.planet_ink.coffee_mud.Commands.StdCommand
      extended by com.planet_ink.coffee_mud.Commands.Go
All Implemented Interfaces:
Command, CMObject, java.lang.Cloneable, java.lang.Comparable<CMObject>
Direct Known Subclasses:
Above, Aft, Below, Crawl, Down, East, Enter, Flee, Foreward, North, Northeast, Northwest, Portside, Pull, Push, Run, South, Southeast, Southwest, Starboard, TypeCmd, Up, West

public class Go
extends StdCommand


Field Summary
protected  java.util.List<java.lang.String> ifneccvec
           
protected  Command stander
           
 
Fields inherited from class com.planet_ink.coffee_mud.Commands.StdCommand
ID, noCoinFilter
 
Constructor Summary
Go()
           
 
Method Summary
 double actionsCost(MOB mob, java.util.List<java.lang.String> cmds)
          Returns the number of actions required to completely activate this command.
 boolean canBeOrdered()
          Whether the a group leader or charmer can order their followers to do this command.
 boolean execute(MOB mob, java.util.List<java.lang.String> commands, int metaFlags)
          This method actually performs the command, when the given parsed set of command-line words.
 java.lang.String[] getAccessWords()
          Returns the set of command words, with the most public one first, that are entered by the user to initiate this command.
 boolean standIfNecessary(MOB mob, java.util.List<java.lang.String> commands, int metaFlags, boolean giveMsg)
           
 
Methods inherited from class com.planet_ink.coffee_mud.Commands.StdCommand
checkArguments, checkedActionsCost, combatActionsCost, compareTo, copyOf, executeInternal, I, ID, initializeClass, L, name, newInstance, preExecute, securityCheck
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

stander

protected Command stander

ifneccvec

protected java.util.List<java.lang.String> ifneccvec
Constructor Detail

Go

public Go()
Method Detail

getAccessWords

public java.lang.String[] getAccessWords()
Description copied from interface: Command
Returns the set of command words, with the most public one first, that are entered by the user to initiate this command.

Specified by:
getAccessWords in interface Command
Overrides:
getAccessWords in class StdCommand
Returns:
the set of command words that the user enters

standIfNecessary

public boolean standIfNecessary(MOB mob,
                                java.util.List<java.lang.String> commands,
                                int metaFlags,
                                boolean giveMsg)
                         throws java.io.IOException
Throws:
java.io.IOException

execute

public boolean execute(MOB mob,
                       java.util.List<java.lang.String> commands,
                       int metaFlags)
                throws java.io.IOException
Description copied from interface: Command
This method actually performs the command, when the given parsed set of command-line words. The commands list is almost always the set of strings, starting with the access word that triggered the command. Some commands have custom APIs however, that allow almost anything to be in the commands list, or even for the commands to be null. This method is not allowed to be called until the player or mob has satisfied the actionsCost requirements and the securityCheck

Specified by:
execute in interface Command
Overrides:
execute in class StdCommand
Parameters:
mob - the mob or player issueing the command
commands - usually the command words and parameters; a set of strings
metaFlags - flags denoting how the command is being executed
Returns:
whether the command was successfully executed. Is almost meaningless.
Throws:
java.io.IOException - usually means the player has dropped carrier
See Also:
Command.actionsCost(MOB, List), Command.securityCheck(MOB)

actionsCost

public double actionsCost(MOB mob,
                          java.util.List<java.lang.String> cmds)
Description copied from interface: Command
Returns the number of actions required to completely activate this command. A value of 0.0 means perform instantly. This method only applies when the user is not in combat.

Specified by:
actionsCost in interface Command
Overrides:
actionsCost in class StdCommand
Parameters:
mob - the mob executing the command, if any
cmds - the parameters to be passed to the command, if any
Returns:
the number of player free actions required to do this
See Also:
Command.combatActionsCost(MOB, List), Command.checkedActionsCost(MOB, List)

canBeOrdered

public boolean canBeOrdered()
Description copied from interface: Command
Whether the a group leader or charmer can order their followers to do this command.

Specified by:
canBeOrdered in interface Command
Overrides:
canBeOrdered in class StdCommand
Returns:
whether this command can be ordered.