com.planet_ink.coffee_mud.Commands
Class Possess

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

public class Possess
extends StdCommand


Field Summary
 
Fields inherited from class com.planet_ink.coffee_mud.Commands.StdCommand
ID, noCoinFilter
 
Constructor Summary
Possess()
           
 
Method Summary
 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.Object executeInternal(MOB mob, int metaFlags, java.lang.Object... args)
          This method is used for making "insider" calls to the command.
 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.
 MOB getTarget(MOB mob, java.util.List<java.lang.String> commands, boolean quiet)
           
protected  boolean possess(MOB mob, MOB target, boolean quiet)
           
 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, I, ID, initializeClass, L, name, newInstance, preExecute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Possess

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

getTarget

public MOB getTarget(MOB mob,
                     java.util.List<java.lang.String> commands,
                     boolean quiet)

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)

possess

protected boolean possess(MOB mob,
                          MOB target,
                          boolean quiet)

executeInternal

public java.lang.Object executeInternal(MOB mob,
                                        int metaFlags,
                                        java.lang.Object... args)
                                 throws java.io.IOException
Description copied from interface: Command
This method is used for making "insider" calls to the command. It's parameters and implementation can follow any rules you like. The engine will sometimes use these to make direct calls to the command implementations.

Specified by:
executeInternal in interface Command
Overrides:
executeInternal in class StdCommand
Parameters:
mob - the mob or player issueing the command
metaFlags - flags denoting how the command is being executed
args - a set of object parameters
Returns:
a object response
Throws:
java.io.IOException - usually means the player has dropped carrier

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.

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