Package com.planet_ink.coffee_mud.Commands

Class Catalog

java.lang.Object

com.planet_ink.coffee_mud.Commands.StdCommand

com.planet_ink.coffee_mud.Commands.Catalog

All Implemented Interfaces:

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

public class Catalog
extends StdCommand

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.TreeMap<java.lang.String,java.lang.String>	currentCats

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

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

ID, noCoinFilter

Constructor Summary

Constructors

Constructor	Description
Catalog()

Method Summary

Modifier and Type	Method	Description
boolean	canBeOrdered()	Whether a group leader or charmer can order their followers to do this command.
boolean	catalog(Room R, MOB mob, Physical P)
boolean	checkUserRoomSetEntry(java.util.List<java.lang.String> commands)
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.
Physical	findCatalog(CatalogLibrary.CatalogKind whatKind, java.lang.String ID, boolean exactOnly)
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.
CatalogLibrary.CatalogKind	getObjectType(java.util.List<java.lang.String> commands)
java.util.Enumeration<java.lang.String>	getRoomSet(MOB mob, java.lang.String which)
protected java.lang.String	listCatagories(CatalogLibrary.CatalogKind whatKind)
boolean	securityCheck(MOB mob)	Whether this command is available to the given player

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

actionsCost, canBeCancelled, checkArguments, checkedActionsCost, combatActionsCost, compareTo, copyOf, executeInternal, getArgumentSetIndex, getVisibleRoomTarget, I, ID, initializeClass, isOccupiedWithOtherWork, L, name, newInstance, preExecute, putInCommandlist

Field Detail

currentCats

protected java.util.TreeMap<java.lang.String,java.lang.String> currentCats

Constructor Detail

Catalog

public Catalog()

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

catalog

public boolean catalog(Room R,
                       MOB mob,
                       Physical P)
                throws java.io.IOException

Throws:

java.io.IOException

findCatalog

public Physical findCatalog(CatalogLibrary.CatalogKind whatKind,
                            java.lang.String ID,
                            boolean exactOnly)

getRoomSet

public java.util.Enumeration<java.lang.String> getRoomSet(MOB mob,
                                                          java.lang.String which)

getObjectType

public CatalogLibrary.CatalogKind getObjectType(java.util.List<java.lang.String> commands)

checkUserRoomSetEntry

public boolean checkUserRoomSetEntry(java.util.List<java.lang.String> commands)

listCatagories

protected java.lang.String listCatagories(CatalogLibrary.CatalogKind whatKind)

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)

canBeOrdered

public boolean canBeOrdered()

Description copied from interface: Command

Whether 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