com.planet_ink.coffee_mud.Commands
Class Deviations

java.lang.Object
  extended by com.planet_ink.coffee_mud.Commands.StdCommand
      extended by com.planet_ink.coffee_mud.Commands.Deviations
All Implemented Interfaces:
Command, CMObject, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class Deviations
extends StdCommand


Field Summary
 
Fields inherited from class com.planet_ink.coffee_mud.Commands.StdCommand
ID, noCoinFilter
 
Fields inherited from interface com.planet_ink.coffee_mud.Commands.interfaces.Command
METAFLAG_AS, METAFLAG_FORCED, METAFLAG_MPFORCED, METAFLAG_ORDER, METAFLAG_POSSESSED, METAFLAG_SNOOPED
 
Constructor Summary
Deviations()
           
 
Method Summary
 boolean alreadyDone(Environmental E, java.util.Vector itemsDone)
           
 boolean canBeOrdered()
          Whether the a group leader or charmer can order their followers to do this command.
 java.lang.StringBuffer deviations(MOB mob, java.lang.String rest)
           
 boolean execute(MOB mob, java.util.Vector 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.
protected  java.lang.String getDeviation(int val, int val2)
           
protected  java.lang.String getDeviation(int val, java.util.Map<java.lang.String,java.lang.String> vals, java.lang.String key)
           
protected  java.lang.String itemHeader()
           
protected  java.lang.String mobHeader(Faction useFaction)
           
 boolean securityCheck(MOB mob)
          Whether this command is available to the given player
 
Methods inherited from class com.planet_ink.coffee_mud.Commands.StdCommand
actionsCost, checkArguments, checkedActionsCost, combatActionsCost, compareTo, copyOf, executeInternal, ID, initializeClass, name, newInstance, preExecute, staffCommand
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Deviations

public Deviations()
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

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.

mobHeader

protected java.lang.String mobHeader(Faction useFaction)

itemHeader

protected java.lang.String itemHeader()

alreadyDone

public boolean alreadyDone(Environmental E,
                           java.util.Vector itemsDone)

getDeviation

protected java.lang.String getDeviation(int val,
                                        java.util.Map<java.lang.String,java.lang.String> vals,
                                        java.lang.String key)

getDeviation

protected java.lang.String getDeviation(int val,
                                        int val2)

deviations

public java.lang.StringBuffer deviations(MOB mob,
                                         java.lang.String rest)

execute

public boolean execute(MOB mob,
                       java.util.Vector 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)

securityCheck

public boolean securityCheck(MOB mob)
Description copied from interface: Command
Whether this command is available to the given player

Specified by:
securityCheck in interface Command
Overrides:
securityCheck in class StdCommand
Parameters:
mob - the player mob who might not even know about this command
Returns:
true if the command is available, and false if it is unknown