com.planet_ink.coffee_mud.Commands
Class Modify

java.lang.Object
  com.planet_ink.coffee_mud.Commands.StdCommand
      com.planet_ink.coffee_mud.Commands.Modify

All Implemented Interfaces:

Command, CMObject, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class Modify
extends StdCommand

Field Summary

Fields inherited from class com.planet_ink.coffee_mud.Commands.StdCommand

ID, noCoinFilter

Constructor Summary

Modify()

Method Summary

boolean	abilities(MOB mob, java.util.List<java.lang.String> commands)
void	accounts(MOB mob, java.util.List<java.lang.String> commands)
boolean	achievements(MOB mob, java.util.List<java.lang.String> commands)
void	allQualify(MOB mob, java.util.List<java.lang.String> commands)
void	areas(MOB mob, java.util.List<java.lang.String> commands)
boolean	canBeOrdered() Whether the a group leader or charmer can order their followers to do this command.
boolean	classes(MOB mob, java.util.List<java.lang.String> commands)
void	components(MOB mob, java.util.List<java.lang.String> commands)
boolean	craftSkills(MOB mob, java.util.List<java.lang.String> commands)
boolean	errorOut(MOB mob)
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.
void	exits(MOB mob, java.util.List<java.lang.String> commands)
protected void	flunkAreaCmd(MOB mob)
protected void	flunkRoomCmd(MOB mob)
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.
void	items(MOB mob, java.util.List<java.lang.String> commands)
boolean	languages(MOB mob, java.util.List<java.lang.String> commands)
protected java.lang.String	listOfThings()
void	manufacturer(MOB mob, java.util.List<java.lang.String> commands)
void	mobs(MOB mob, java.util.List<java.lang.String> commands)
void	players(MOB mob, java.util.List<java.lang.String> commands)
void	quests(MOB mob, java.util.List<java.lang.String> commands)
boolean	races(MOB mob, java.util.List<java.lang.String> commands)
void	rooms(MOB mob, java.util.List<java.lang.String> commands)
boolean	securityCheck(MOB mob) Whether this command is available to the given player
void	socials(MOB mob, java.util.List<java.lang.String> commands)
void	updateChangedExit(MOB mob, Room baseRoom, Exit thisExit, Exit prevExit)

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

Modify

public Modify()

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

items

public void items(MOB mob,
                  java.util.List<java.lang.String> commands)
           throws java.io.IOException

Throws:

java.io.IOException

flunkRoomCmd

protected void flunkRoomCmd(MOB mob)

flunkAreaCmd

protected void flunkAreaCmd(MOB mob)

rooms

public void rooms(MOB mob,
                  java.util.List<java.lang.String> commands)
           throws java.io.IOException

Throws:

java.io.IOException

accounts

public void accounts(MOB mob,
                     java.util.List<java.lang.String> commands)
              throws java.io.IOException

Throws:

java.io.IOException

areas

public void areas(MOB mob,
                  java.util.List<java.lang.String> commands)
           throws java.io.IOException

Throws:

java.io.IOException

quests

public void quests(MOB mob,
                   java.util.List<java.lang.String> commands)
            throws java.io.IOException

Throws:

java.io.IOException

updateChangedExit

public void updateChangedExit(MOB mob,
                              Room baseRoom,
                              Exit thisExit,
                              Exit prevExit)

exits

public void exits(MOB mob,
                  java.util.List<java.lang.String> commands)
           throws java.io.IOException

Throws:

java.io.IOException

races

public boolean races(MOB mob,
                     java.util.List<java.lang.String> commands)
              throws java.io.IOException

Throws:

java.io.IOException

allQualify

public void allQualify(MOB mob,
                       java.util.List<java.lang.String> commands)
                throws java.io.IOException

Throws:

java.io.IOException

classes

public boolean classes(MOB mob,
                       java.util.List<java.lang.String> commands)
                throws java.io.IOException

Throws:

java.io.IOException

abilities

public boolean abilities(MOB mob,
                         java.util.List<java.lang.String> commands)
                  throws java.io.IOException

Throws:

java.io.IOException

languages

public boolean languages(MOB mob,
                         java.util.List<java.lang.String> commands)
                  throws java.io.IOException

Throws:

java.io.IOException

craftSkills

public boolean craftSkills(MOB mob,
                           java.util.List<java.lang.String> commands)
                    throws java.io.IOException

Throws:

java.io.IOException

components

public void components(MOB mob,
                       java.util.List<java.lang.String> commands)
                throws java.io.IOException

Throws:

java.io.IOException

socials

public void socials(MOB mob,
                    java.util.List<java.lang.String> commands)
             throws java.io.IOException

Throws:

java.io.IOException

players

public void players(MOB mob,
                    java.util.List<java.lang.String> commands)
             throws java.io.IOException

Throws:

java.io.IOException

achievements

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

manufacturer

public void manufacturer(MOB mob,
                         java.util.List<java.lang.String> commands)
                  throws java.io.IOException

Throws:

java.io.IOException

mobs

public void mobs(MOB mob,
                 java.util.List<java.lang.String> commands)
          throws java.io.IOException

Throws:

java.io.IOException

errorOut

public boolean errorOut(MOB mob)

listOfThings

protected java.lang.String listOfThings()

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)

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