Package com.planet_ink.coffee_mud.Commands

Class ListCmd

java.lang.Object

com.planet_ink.coffee_mud.Commands.StdCommand

com.planet_ink.coffee_mud.Commands.ListCmd

All Implemented Interfaces:

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

public class ListCmd
extends StdCommand

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListCmd.ListCmdEntry

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	helpChecked

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
ListCmd()

Method Summary

Modifier and Type	Method	Description
double	actionsCost(MOB mob, java.util.List<java.lang.String> cmds)	Returns the number of actions required to completely activate this command.
void	addEnumeratedStatCodes(java.util.Enumeration<? extends Modifiable> e, java.util.Set<java.lang.String> allKnownFields, java.lang.StringBuffer allFieldsMsg)
void	addScripts(DVector DV, Room R, ShopKeeper SK, MOB M, Item I, PhysicalAgent E)
void	addShopScripts(DVector DV, Room R, MOB M, Item I, Environmental E)
protected java.lang.StringBuilder	appendTick(int group, int tick, boolean activeOnly, java.lang.String mask, java.lang.String finalCol, int[] col, int[] COL)
void	archonlist(MOB mob, java.util.List<java.lang.String> commands)
java.lang.StringBuilder	areaConquests(Session viewerS, java.util.Enumeration<Area> these)
boolean	canBeOrdered()	Whether a group leader or charmer can order their followers to do this command.
boolean	canShowTo(MOB showTo, MOB show)
java.lang.String	cataMark(Environmental E)
double	combatActionsCost(MOB mob, java.util.List<java.lang.String> cmds)	Returns the number of actions required to completely activate this command.
protected void	dumpThreadGroup(Session viewerS, java.lang.StringBuilder lines, java.lang.ThreadGroup tGroup, boolean ignoreZeroTickThreads, boolean extend)
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.
protected java.lang.Thread	findThread(java.lang.String name, java.lang.ThreadGroup tGroup, boolean ignoreZeroTickThreads)
protected java.lang.String	fixDisplayMask(java.lang.String mask)
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.
ListCmd.ListCmdEntry	getAnyCmd(MOB mob)
java.lang.Comparable<?>	getAreaStatFromSomewhere(Area A, java.lang.String stat)
java.lang.StringBuffer	getAreaStuff(MOB mob, java.util.List<java.lang.String> commands, int start, java.util.Enumeration<Room> r)
java.lang.String	getAreaStuffLine(Room R, MOB mob, Environmental E, Environmental cE, com.planet_ink.coffee_mud.Commands.ListCmd.WikiFlag wiki, int col1, int roomNameCol, java.util.Set<java.lang.String> uniq, ShopKeeper SK, boolean shopOnly)
ListCmd.ListCmdEntry	getMyCmd(MOB mob, java.lang.String s)
java.util.List<java.lang.String>	getMyCmdWords(MOB mob)
java.lang.String	getSpaceObjectType(SpaceObject obj)
protected java.lang.String	getSpecialItemTags(Item I)
java.lang.String	getValue(java.lang.Object o, java.lang.String indention)
java.lang.StringBuilder	journalList(MOB mob, Session viewerS, java.lang.String partialjournal, java.lang.String rest)
void	listAbilities(MOB mob, Session s, java.util.List<java.lang.String> commands, java.lang.String title, int ofType)
void	listAccounts(Session viewerS, MOB mob, java.util.List<java.lang.String> commands)
java.lang.String	listAchievements(Session viewerS)
java.lang.StringBuilder	listAllQualifies(Session viewerS, java.util.List<java.lang.String> cmds)
void	listAreas(MOB mob, java.util.List<java.lang.String> commands, Filterer<Area> filter)
java.lang.String	listAutoAwards(Session viewerS)
java.lang.StringBuilder	listBanks(MOB mob, Session viewerS, java.util.List<java.lang.String> commands)
void	listBehaviors(MOB mob, Session s, java.util.List<java.lang.String> commands, java.lang.String title)
java.lang.StringBuilder	listCharClasses(Session viewerS, java.util.Enumeration<CharClass> these, java.util.List<java.lang.String> commands)
java.lang.String	listClanGovernments(Session viewerS, java.util.List<java.lang.String> commands)
java.lang.String	listClans(Session viewerS, java.util.List<java.lang.String> commands)
java.lang.StringBuilder	listCommandJournals(Session viewerS)
void	listCommands(MOB mob, java.util.List<java.lang.String> commands)
java.lang.String	listComponents(Session viewerS)
java.lang.StringBuilder	listContent(MOB mob, java.util.List<java.lang.String> commands)
java.lang.String	listCron(Session viewerS, java.lang.String rest)
void	listCurrents(MOB mob, java.util.List<java.lang.String> commands)
java.lang.String	listEnvResources(Session viewerS, java.lang.String rest)
java.lang.String	listExpertises(Session viewerS, java.util.List<java.lang.String> commands)
java.lang.String	listExpired(MOB mob)
void	listFileUse(MOB mob, Session S, java.lang.String fileName)
java.lang.String	listHelpFileRequests(MOB mob, java.lang.String rest)
java.lang.StringBuilder	listJournals(Session viewerS)
java.lang.StringBuilder	listLibraries(MOB mob, Session viewerS, java.util.List<java.lang.String> commands)
java.lang.StringBuilder	listLinkages(Session viewerS, MOB mob, java.lang.String rest)
void	listLoadedUsers(Session viewerS, MOB mob, java.util.List<java.lang.String> commands)
void	listLog(MOB mob, java.util.List<java.lang.String> commands)
void	listManufacturers(MOB mob, java.util.List<java.lang.String> commands)
java.lang.String	listMaterials()
java.lang.String	listMQL(MOB mob, boolean areaFlag, java.util.List<java.lang.String> commands)
void	listNews(MOB mob, java.util.List<java.lang.String> commands)
protected java.lang.String	listOneWayDoors(Session viewerS, java.util.List<java.lang.String> commands)
protected java.lang.String	listOrphans(Session viewerS, java.util.List<java.lang.String> commands)
void	listPolls(MOB mob, java.util.List<java.lang.String> commands)
java.lang.StringBuilder	listPostOffices(MOB mob, Session viewerS, java.util.List<java.lang.String> commands)
java.lang.StringBuilder	listQuestNames(Session viewerS, java.lang.String rest)
java.lang.StringBuilder	listQuests(Session viewerS, java.lang.String rest)
java.lang.StringBuilder	listQuestWinners(Session viewerS, java.lang.String rest)
java.lang.StringBuilder	listRaceCats(Session viewerS, java.util.Enumeration<Race> these, java.util.List<java.lang.String> commands)
java.lang.StringBuilder	listRaces(Session viewerS, java.util.Enumeration<Race> these, java.lang.String rest)
java.lang.String	listRecipes(MOB mob, java.lang.String rest)
java.lang.StringBuilder	listReports(Session viewerS, MOB mob)
java.lang.String	listResources(MOB mob, java.lang.String parm)
java.lang.StringBuilder	listScripts(Session viewerS, MOB mob, java.util.List<java.lang.String> cmds)
void	listSessions(MOB mob, java.util.List<java.lang.String> commands)
void	listShips(MOB mob, java.util.List<java.lang.String> commands)
java.lang.String	listSocials(Session viewerS, java.util.List<java.lang.String> commands)
java.lang.String	listSpace(MOB mob, java.util.List<java.lang.String> commands)
void	listSql(MOB mob, java.lang.String rest)
void	listStats(MOB mob, java.util.List<java.lang.String> commands)
java.lang.StringBuilder	listSubOps(Session viewerS)
java.lang.StringBuilder	listThread(Session viewerS, MOB mob, java.lang.String threadname)
java.lang.StringBuilder	listThreads(Session viewerS, MOB mob, boolean ignoreZeroTickThreads, boolean extend)
java.lang.StringBuilder	listTicks(Session viewerS, java.lang.String whichGroupStr)
void	listTimeZones(MOB mob, java.util.List<java.lang.String> commands, Filterer<Area> filter)
java.lang.String	listTitles(Session viewerS)
protected java.lang.String	listUnlinkedExits(Session viewerS, java.util.List<java.lang.String> commands)
void	listUsers(Session viewerS, MOB mob, java.util.List<java.lang.String> commands)
boolean	pause(Session sess)
java.lang.StringBuilder	roomDetails(Session viewerS, java.util.Enumeration<Room> these, Room likeRoom, java.lang.String rest)
java.lang.StringBuilder	roomDetails(Session viewerS, java.util.List<Room> these, Room likeRoom, java.lang.String rest)
java.lang.StringBuilder	roomExpires(Session viewerS, java.util.Enumeration<Room> these, Room likeRoom)
java.lang.StringBuilder	roomPropertyDetails(Session viewerS, Area A, java.lang.String rest)
java.lang.StringBuilder	roomPropertyDetails(Session viewerS, java.util.Enumeration<Room> these, java.lang.String owner, boolean taxes)
java.lang.StringBuilder	roomResources(Session viewerS, java.util.Enumeration<Room> these, Room likeRoom)
java.lang.StringBuilder	roomResources(Session viewerS, java.util.Vector<Room> these, Room likeRoom)
java.lang.StringBuilder	roomTypes(MOB mob, java.util.Enumeration<Room> these, Room likeRoom, java.util.List<java.lang.String> commands)
java.lang.String	wikiFix(java.lang.String s, char[] newChars, boolean noSpaces)

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

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

Field Detail

helpChecked

protected boolean helpChecked

Constructor Detail

ListCmd

public ListCmd()

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

listAllQualifies

public java.lang.StringBuilder listAllQualifies(Session viewerS,
                                                java.util.List<java.lang.String> cmds)

roomDetails

public java.lang.StringBuilder roomDetails(Session viewerS,
                                           java.util.List<Room> these,
                                           Room likeRoom,
                                           java.lang.String rest)

roomDetails

public java.lang.StringBuilder roomDetails(Session viewerS,
                                           java.util.Enumeration<Room> these,
                                           Room likeRoom,
                                           java.lang.String rest)

roomExpires

public java.lang.StringBuilder roomExpires(Session viewerS,
                                           java.util.Enumeration<Room> these,
                                           Room likeRoom)

roomPropertyDetails

public java.lang.StringBuilder roomPropertyDetails(Session viewerS,
                                                   java.util.Enumeration<Room> these,
                                                   java.lang.String owner,
                                                   boolean taxes)

roomPropertyDetails

public java.lang.StringBuilder roomPropertyDetails(Session viewerS,
                                                   Area A,
                                                   java.lang.String rest)

cataMark

public java.lang.String cataMark(Environmental E)

canShowTo

public boolean canShowTo(MOB showTo,
                         MOB show)

getSpecialItemTags

protected java.lang.String getSpecialItemTags(Item I)

wikiFix

public java.lang.String wikiFix(java.lang.String s,
                                char[] newChars,
                                boolean noSpaces)

getAreaStuffLine

public java.lang.String getAreaStuffLine(Room R,
                                         MOB mob,
                                         Environmental E,
                                         Environmental cE,
                                         com.planet_ink.coffee_mud.Commands.ListCmd.WikiFlag wiki,
                                         int col1,
                                         int roomNameCol,
                                         java.util.Set<java.lang.String> uniq,
                                         ShopKeeper SK,
                                         boolean shopOnly)

getAreaStuff

public java.lang.StringBuffer getAreaStuff(MOB mob,
                                           java.util.List<java.lang.String> commands,
                                           int start,
                                           java.util.Enumeration<Room> r)

roomTypes

public java.lang.StringBuilder roomTypes(MOB mob,
                                         java.util.Enumeration<Room> these,
                                         Room likeRoom,
                                         java.util.List<java.lang.String> commands)

roomResources

public java.lang.StringBuilder roomResources(Session viewerS,
                                             java.util.Vector<Room> these,
                                             Room likeRoom)

roomResources

public java.lang.StringBuilder roomResources(Session viewerS,
                                             java.util.Enumeration<Room> these,
                                             Room likeRoom)

areaConquests

public java.lang.StringBuilder areaConquests(Session viewerS,
                                             java.util.Enumeration<Area> these)

dumpThreadGroup

protected void dumpThreadGroup(Session viewerS,
                               java.lang.StringBuilder lines,
                               java.lang.ThreadGroup tGroup,
                               boolean ignoreZeroTickThreads,
                               boolean extend)

findThread

protected java.lang.Thread findThread(java.lang.String name,
                                      java.lang.ThreadGroup tGroup,
                                      boolean ignoreZeroTickThreads)

listThreads

public java.lang.StringBuilder listThreads(Session viewerS,
                                           MOB mob,
                                           boolean ignoreZeroTickThreads,
                                           boolean extend)

listThread

public java.lang.StringBuilder listThread(Session viewerS,
                                          MOB mob,
                                          java.lang.String threadname)

addScripts

public void addScripts(DVector DV,
                       Room R,
                       ShopKeeper SK,
                       MOB M,
                       Item I,
                       PhysicalAgent E)

addShopScripts

public void addShopScripts(DVector DV,
                           Room R,
                           MOB M,
                           Item I,
                           Environmental E)

listScripts

public java.lang.StringBuilder listScripts(Session viewerS,
                                           MOB mob,
                                           java.util.List<java.lang.String> cmds)

listLinkages

public java.lang.StringBuilder listLinkages(Session viewerS,
                                            MOB mob,
                                            java.lang.String rest)

journalList

public java.lang.StringBuilder journalList(MOB mob,
                                           Session viewerS,
                                           java.lang.String partialjournal,
                                           java.lang.String rest)

listReports

public java.lang.StringBuilder listReports(Session viewerS,
                                           MOB mob)

listUsers

public void listUsers(Session viewerS,
                      MOB mob,
                      java.util.List<java.lang.String> commands)

listLoadedUsers

public void listLoadedUsers(Session viewerS,
                            MOB mob,
                            java.util.List<java.lang.String> commands)

listAccounts

public void listAccounts(Session viewerS,
                         MOB mob,
                         java.util.List<java.lang.String> commands)

listRaces

public java.lang.StringBuilder listRaces(Session viewerS,
                                         java.util.Enumeration<Race> these,
                                         java.lang.String rest)

listCharClasses

public java.lang.StringBuilder listCharClasses(Session viewerS,
                                               java.util.Enumeration<CharClass> these,
                                               java.util.List<java.lang.String> commands)

listRaceCats

public java.lang.StringBuilder listRaceCats(Session viewerS,
                                            java.util.Enumeration<Race> these,
                                            java.util.List<java.lang.String> commands)

listPostOffices

public java.lang.StringBuilder listPostOffices(MOB mob,
                                               Session viewerS,
                                               java.util.List<java.lang.String> commands)

listBanks

public java.lang.StringBuilder listBanks(MOB mob,
                                         Session viewerS,
                                         java.util.List<java.lang.String> commands)

listLibraries

public java.lang.StringBuilder listLibraries(MOB mob,
                                             Session viewerS,
                                             java.util.List<java.lang.String> commands)

listQuests

public java.lang.StringBuilder listQuests(Session viewerS,
                                          java.lang.String rest)

listQuestNames

public java.lang.StringBuilder listQuestNames(Session viewerS,
                                              java.lang.String rest)

listQuestWinners

public java.lang.StringBuilder listQuestWinners(Session viewerS,
                                                java.lang.String rest)

listJournals

public java.lang.StringBuilder listJournals(Session viewerS)

listCommandJournals

public java.lang.StringBuilder listCommandJournals(Session viewerS)

appendTick

protected java.lang.StringBuilder appendTick(int group,
                                             int tick,
                                             boolean activeOnly,
                                             java.lang.String mask,
                                             java.lang.String finalCol,
                                             int[] col,
                                             int[] COL)

listTicks

public java.lang.StringBuilder listTicks(Session viewerS,
                                         java.lang.String whichGroupStr)

listSubOps

public java.lang.StringBuilder listSubOps(Session viewerS)

listOneWayDoors

protected java.lang.String listOneWayDoors(Session viewerS,
                                           java.util.List<java.lang.String> commands)

listOrphans

protected java.lang.String listOrphans(Session viewerS,
                                       java.util.List<java.lang.String> commands)

listUnlinkedExits

protected java.lang.String listUnlinkedExits(Session viewerS,
                                             java.util.List<java.lang.String> commands)

getValue

public java.lang.String getValue(java.lang.Object o,
                                 java.lang.String indention)

listResources

public java.lang.String listResources(MOB mob,
                                      java.lang.String parm)

listHelpFileRequests

public java.lang.String listHelpFileRequests(MOB mob,
                                             java.lang.String rest)

listRecipes

public java.lang.String listRecipes(MOB mob,
                                    java.lang.String rest)

listMaterials

public java.lang.String listMaterials()

getSpaceObjectType

public java.lang.String getSpaceObjectType(SpaceObject obj)

listSpace

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

listExpired

public java.lang.String listExpired(MOB mob)

listEnvResources

public java.lang.String listEnvResources(Session viewerS,
                                         java.lang.String rest)

listMQL

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

listCron

public java.lang.String listCron(Session viewerS,
                                 java.lang.String rest)

getMyCmdWords

public java.util.List<java.lang.String> getMyCmdWords(MOB mob)

getMyCmd

public ListCmd.ListCmdEntry getMyCmd(MOB mob,
                                     java.lang.String s)

getAnyCmd

public ListCmd.ListCmdEntry getAnyCmd(MOB mob)

listComponents

public java.lang.String listComponents(Session viewerS)

fixDisplayMask

protected java.lang.String fixDisplayMask(java.lang.String mask)

listExpertises

public java.lang.String listExpertises(Session viewerS,
                                       java.util.List<java.lang.String> commands)

listSocials

public java.lang.String listSocials(Session viewerS,
                                    java.util.List<java.lang.String> commands)

listTitles

public java.lang.String listTitles(Session viewerS)

listAutoAwards

public java.lang.String listAutoAwards(Session viewerS)

listAchievements

public java.lang.String listAchievements(Session viewerS)

listClanGovernments

public java.lang.String listClanGovernments(Session viewerS,
                                            java.util.List<java.lang.String> commands)

listClans

public java.lang.String listClans(Session viewerS,
                                  java.util.List<java.lang.String> commands)

listContent

public java.lang.StringBuilder listContent(MOB mob,
                                           java.util.List<java.lang.String> commands)

listPolls

public void listPolls(MOB mob,
                      java.util.List<java.lang.String> commands)

listFileUse

public void listFileUse(MOB mob,
                        Session S,
                        java.lang.String fileName)

listLog

public void listLog(MOB mob,
                    java.util.List<java.lang.String> commands)

pause

public boolean pause(Session sess)

listNews

public void listNews(MOB mob,
                     java.util.List<java.lang.String> commands)

listSql

public void listSql(MOB mob,
                    java.lang.String rest)

getAreaStatFromSomewhere

public java.lang.Comparable<?> getAreaStatFromSomewhere(Area A,
                                                        java.lang.String stat)

listCommands

public void listCommands(MOB mob,
                         java.util.List<java.lang.String> commands)

listManufacturers

public void listManufacturers(MOB mob,
                              java.util.List<java.lang.String> commands)

addEnumeratedStatCodes

public void addEnumeratedStatCodes(java.util.Enumeration<? extends Modifiable> e,
                                   java.util.Set<java.lang.String> allKnownFields,
                                   java.lang.StringBuffer allFieldsMsg)

listStats

public void listStats(MOB mob,
                      java.util.List<java.lang.String> commands)

listCurrents

public void listCurrents(MOB mob,
                         java.util.List<java.lang.String> commands)

listShips

public void listShips(MOB mob,
                      java.util.List<java.lang.String> commands)

listAbilities

public void listAbilities(MOB mob,
                          Session s,
                          java.util.List<java.lang.String> commands,
                          java.lang.String title,
                          int ofType)

listBehaviors

public void listBehaviors(MOB mob,
                          Session s,
                          java.util.List<java.lang.String> commands,
                          java.lang.String title)

listTimeZones

public void listTimeZones(MOB mob,
                          java.util.List<java.lang.String> commands,
                          Filterer<Area> filter)

listAreas

public void listAreas(MOB mob,
                      java.util.List<java.lang.String> commands,
                      Filterer<Area> filter)

listSessions

public void listSessions(MOB mob,
                         java.util.List<java.lang.String> commands)

archonlist

public void archonlist(MOB mob,
                       java.util.List<java.lang.String> commands)

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)

combatActionsCost

public double combatActionsCost(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 fighting in combat.

Specified by:

combatActionsCost in interface Command

Overrides:

combatActionsCost 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.actionsCost(MOB, List), Command.checkedActionsCost(MOB, List)

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 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.