LIST(Builder)

CoffeeMUD
Administrator                                                  Builder                                                              Player

=CoffeeMUD Builder Information=
Basics	Praetor     Player Support     Commands     Zapper Masks	Advanced	Races     Classes     Abilities     Socials     Scripting
Building	Behaviors     Properties     Areas     Rooms     Exits     Items     Mobs	Systems	Achievements     Crafting     Help Info     Ships     Planes of Existence     Quests     Triumphs

===LIST===
Usage:	LIST ("SHOPKEEPER") (FOR "ITEMNAME")
Examples:	list list weaponsmith list shopkeeper for shield
Shorts:
Description:	The normal player version of this command will display the items which a particular shopkeeper MOB may be selling, along with the prices being offered to your characters. If more than one shopkeeper is in the room, you may have to specify the shopkeeper name in the parameters. You may add the key word FOR and an item name to the end to filter the results. See also BUY, SELL, DEPOSIT, WITHDRAW, VIEW, BID. The Admin version can also be qualified with ACHIEVEMENTS,UNLINKEDEXITS, ITEMS, ARMOR, ENVRESOURCES, WEAPONS, MOBS, ROOMS, AREA, LOCALES, BEHAVIORS, EXITS, RACES, CLASSES, STAFF, SPELLS, SONGS, PRAYERS, PROPERTIES, THIEFSKILLS, COMMON, JOURNALS, SKILLS, QUESTS, DISEASES, POISONS, TICKS, MAGIC ITEMS, TECH, CLANITEMS, COMMANDJOURNAL, TITLES, NOPURGE, BANNED, RACECATS, LOG, USERS, LINKAGES, REPORTS, THREADS, RESOURCES, ONEWAYDOORS, CHANTS, POWERS, SUPERPOWERS, CLANS, GOVERNMENTS, FACTIONS, MATERIALS, OBJCOUNTERS, POLLS, CONTENTS, BUGS, TYPOS, IDEAS, TASKS, NEWS, AREAS, SESSIONS, AREATYPE, REALESTATE or ASSISTS depending upon the listers security. Additional help *may* be available ingame by entering HELP LIST [X] where X is one of the above.

Notes

This is a very powerful command with a ton of variations.

• For LIST ROOMTYPES, use LIST LOCALES instead (it displays both roomtypes and locales).

LIST ABILITIES

===LIST ABILITIES===
Usage:	LIST ABILITIES (DOMAIN_NAME) LIST ABILITIES (DOMAIN_NAME) WIKI LIST ABILITIES (DOMAIN_NAME) WIKIHELP
Examples:	LIST ABILITIES LIST ABILITIES WIKI LIST ABILITIES NATURE_LORE
Shorts:
Description:	Shows the list of java classes (ability ids) available to archons.

Notes

This use of the LIST command can also be extended to CHANTS, COMMON, DISEASES, POWERS, PRAYERS, PROPERTIES, SONGS, SKILLS, SPELLS, SUPERPOWERS, THIEFSKILLS, and TRAPS by replacing the ABILITY keyword with the more limited keyword.

• The WIKI parameter will output the list with special formatting for easily pasting the list into a wiki page.
• The WIKIHELP parameter will output each ABILITY into specific wiki templates for that ability type.
• If a domain name has a space in it, such as "Nature Lore", use an underscore for this command, as shown in the example above.

LIST AREA

===LIST ACHIEVEMENTS===
Usage:	LIST ACHIEVEMENTS
Examples:	list achievements
Shorts:
Description:	Shows all the achievements available to players.

LIST AREA

===LIST AREA===
Usage:	LIST AREA (ROOM/MOB/ITEM/SHOPS/MOBMASK/ITEMMASK) ([MASK])
Examples:	list area list area mob creeper list area mobmask -race +elf
Shorts:
Description:	Lists all the rooms in the current area, along with the locale type of each room. Optionally, a specifier can be added to search for rooms, mobs, items by name, or mobs and items by zapper mask using the mobmask/itemmask parameters.

LIST AREAS

===LIST AREAS===
Usage:	LIST AREAS (SORTBY [COLUMN]...) (COLS [COLUMN]...))
Examples:	list areas list areas sortby cols name population list areas sortby name
Shorts:
Description:	Lists all the standard areas in your game. By default, it also shows whether the area is Hidden, how many rooms are in the area, whether it is in a passive or active state, its current population, and the median level. If the sortby parameter is used, then you can follow it with the order of columns to sort by. Valid columns include: NAME, AUTHOR, DESCRIPTION , ROOMS, STATE, HIDDEN, POPULATION, MIN_LEVEL, MAX_LEVEL, AVG_LEVEL, MED_LEVEL, AVG_ALIGNMENT, MED_ALIGNMENT, TOTAL_LEVELS, TOTAL_INTELLIGENT_LEVELS, VISITABLE_ROOMS, INDOOR_ROOMS. If the columns parameter is used, then you can follow it with columns to substitute in the table.

LIST AREATYPE

===LIST AREATYPE===
Usage:	LIST AREATYPE
Examples:	list areatype
Shorts:
Description:	Shows the list of the area type ids (class ids).

LIST BANNED

===LIST BANNED===
Usage:	LIST BANNED
Examples:	list banned
Shorts:
Description:	Lists the player names, ip addresses, or ip masks that are banned from your mud.

LIST BEHAVIORS

===LIST BEHAVIORS===
Usage:	LIST BEHAVIORS (WIKI/WIKIHELP)
Examples:	list behaviors
Shorts:
Description:	Shows the list of behavior java classes (behavior ids) available to archons.

Notes

This information can also be found on the wiki at the Behaviors page.

• The WIKI parameter will output the list with special formatting for easily pasting the list into a wiki page.
• The WIKIHELP parameter will output each BEHAVIOR into specific wiki templates for Behaviors.

LIST CLANS

===LIST CLANS===
Usage:	LIST CLANS
Examples:	list clans
Shorts:
Description:	Lists all the clans in your mud, along with the number of members each clan has.

LIST BUGS

===LIST BUG===
Usage:	LIST (CMDJOURNAL NAME) (TO)
Examples:	LIST BUGS LIST BUGS LOKI LIST TYPO LIST TASK LIST IDEA LIST NEWS LIST ASSIST
Shorts:
Description:	Lists all the entries in the SYSTEM_(CMDJOURNAL NAME) journal. An optional name can be appended to show entries assign to that name.

Notes

This LIST command works with any SYSTEM_CMDJOURNAL. To edit the entries (including deleting, assigning or transferring), use the REVIEW command.

• In the Mud Grinder, you can only assign entries to players or entities that already have an entry assigned to them.
• In the Command Line, you can assign an entry to any player, or even a non-player.
  • It is recommended to use an underscore before a non-player entity name. For example _DueByJanuary would be a great name for an assigned entry.

LIST CLASSES

===LIST CLASSES===
Usage:	LIST CLASSES (SHORT/WIKI/WIKIHELP)
Examples:	list classes list classes short list classes wiki
Shorts:
Description:	Shows the list of char class java classes (charclass ids) available to archons. Charclasses will have their base classes shown in () next to the ID. Charclasses with an * next to them are Generic. Adding the short parameter will only show a simple list of char class ids.

Notes

• The SHORT parameter will provide a comma delimited list of classes.
• The WIKI parameter will output the list with special formatting for easily pasting the list into a wiki page.
• The WIKIHELP parameter will output each CLASS into specific wiki templates for classes.

LIST COMMANDJOURNAL

===LIST COMMANDJOURNAL===
Usage:	LIST COMMANDJOURNAL
Examples:	list commandjournal
Shorts:
Description:	Further help is not yet available. May be unimplemented.

Notes

This command does not work at this time. You can find this list as a subset of the LIST JOURNALS command. All of the command journals are the ones in all capitals that begin with the string "SYSTEM_".

LIST CONTENTS

===LIST CONTENTS===
Usage:	LIST CONTENTS (AREA/[AREA NAME])
Examples:	list contents list contents area list contents Mud School
Shorts:
Description:	Lists all the mobs and items in the current room, along with their level and alignment. Adding an AREA parameter will do this for the whole current area, or you can enter the name of a particular area.

LIST ENVRESOURCES

===LIST ENVRESOURCES===
Usage:	LIST ENVRESOURCES (SHORT) (MASK)
Examples:	list envresources list envresources short list envresources vegetation
Shorts:
Description:	Lists all the raw material resources defined for your mud, along with its material type, money value, frequency of occurrence, strength, and what kinds of Locales the resource may be gathered from using the appropriate skill. Adding the short parameter just shows a raw list of resource names. Adding a mask will limit the list to those things that contain the mask.

Notes

• The SHORT parameter will display a comma delimited list of resource names.
• Without the SHORT parameter, this command will display the resource name, material, value, frequency, Str(Strength) and Locales.
  • Material is the basic material type of the resource. This often determines which crafting and gathering skills are used to acquire this resource.
  • Value is the base cost of a pound of that resource. This value often modifies crafted items made with this material, as well as determines how much the resource can be sold to (or bought from) at a resource vendor.
  • Frequency is a relative weight of finding the resource with a gathering skill. The frequency of all resources available within a particular locale are added up, and a random number is chosen amongst them to determine which resources are available after the periodic resource reset. So a resource with a frequency of 4 is twice as likely to be selected as a resource with a frequency of 2, and 4 times as likely to be selected as a resource with a frequency of 1.
  • Strength is the overall durability of the item. This affects the likelihood of the item being damaged or destroyed in combat.
  • Locales are the types of rooms in which the resource can be naturally gathered.
    • This can be overridden with the ResourceOverride behavior or altered with the CommonTwister property.

LIST EXITS

===LIST EXITS===
Usage:	LIST EXITS
Examples:	list exits
Shorts:
Description:	Shows the list of exit java classes (exit ids) available to archons.

LIST FACTIONS

===LIST FACTIONS===
Usage:	LIST FACTIONS
Examples:	list faction
Shorts:
Description:	Lists the friendly names of all the factions defined in your game, along with the file/path that defines that faction.

LIST GOVERNMENTS

===LIST GOVERNMENTS===
Usage:	LIST GOVERNMENTS
Examples:	list governments
Shorts:
Description:	Lists all the clan governments that have been defined in your mud.

LIST ITEMS

===LIST ITEMS===
Usage:	LIST ITEMS LIST MAGIC ITEMS LIST ARMOR LIST WEAPONS LIST CLANITEMS LIST TECH
Examples:	list items list weapons
Shorts:
Description:	Shows the item java classes (item ids, magic item ids, armor ids, weapon ids, clanitem ids, tech ids) available to archons.

Notes

• Each of these lists is a separate category of java classes. There is no master list for items of all types.

LIST JOURNALS

===LIST JOURNALS===
Usage:	LIST JOURNALS
Examples:	list journals
Shorts:
Description:	Shows the list of all Journals (message/note areas) that exist in your database, along with the number of entries in each journal.

Notes

• You can use the LIST command on any SYSTEM_ journal. For example, you can do LIST BUGS on the SYSTEM_BUGS journal.

LIST LINKAGES

===LIST LINKAGES===
Usage:	LIST LINKAGES (WORLD) (SUBSTATS)
Examples:	list linkages
Shorts:
Description:	This bizarre command will list area rooms, showing number of rooms, number of mobs, average mob levels, and average alignment. It will also show how many groups of rooms refer back to other rooms in the area, and which areas rooms in this area link to. If you add the WORLD parameter, then all areas are listed. If you add the SUBSTATS parameter, then the linking areas stats are shown instead of the linking room ids.

Notes

• The SUBSTATS parameter is an excellent way to make sure your areas don't have a large disparity between the levels of mobs in connected areas.
  • If there is a large level difference, then it is recommended to put some sort of barrier or warning in place to prevent lower level players from accidentally wandering in to an area that will result in their death.

LIST LOCALES

===LIST LOCALES===
Usage:	LIST LOCALES
Examples:	list locales
Shorts:
Description:	Shows the list of room java classes (locale ids) available to archons.

LIST LOG

===LIST LOG===
Usage:	LIST LOG (FRONT [NUMBER]/BACK [NUMBER]/SKIP [NUMBER])
Examples:	list log list log first 10 list log last 20 list log skip 50
Shorts:
Description:	Displays the server log. If you use the first X param, it will only show the first X lines of the log. If you use the last X param, it will only show the last X lines. If you use the skip X param, it will show the entire log after the first X lines.

LIST MAGIC

===LIST MAGIC===
Usage:	LIST MAGIC
Examples:	list materials
Shorts:
Description:	Shows the list of magic item java classes (item ids) available to archons.

Notes

• There is some mismatch between LIST ITEMS and LIST MAGIC.

LIST MATERIALS

===LIST MATERIALS===
Usage:	LIST MATERIALS
Examples:	list materials
Shorts:
Description:	Lists all the base material types. Use list ENVRESOURCES for what you probably want.

Notes

This provides a comma delimited list of material types, which is a useful way to limit list ENVRESOURCES queries.

LIST MOBS

===LIST MOBS===
Usage:	LIST MOBS
Examples:	list mobs
Shorts:
Description:	Shows the mob java classes (mob ids) available to archons.

LIST NOPURGE

===LIST NOPURGE===
Usage:	LIST NOPURGE
Examples:	list nopurge
Shorts:
Description:	Lists the names of accounts or players who are exempt from the account/player purging rules defined in your coffeemud.ini file. In short, these users will never be deleted, even if they never ever log in again.

Notes

See NOPURGE for adding players to the NOPURGE list, and DESTROY for removing players from the NOPURGE list.

LIST OBJCOUNTERS

===LIST OBJCOUNTERS===
Usage:	LIST OBJCOUNTERS
Examples:	list objcounters
Shorts:
Description:	Deprecated, but may be revived again in the future if I start seeing memory consumption issues.

Notes

DEPRECATED COMMAND.

LIST ONEWAYDOORS

===LIST ONEWAYDOORS===
Usage:	LIST ONEWAYDOORS (LOG)
Examples:	list onewaydoors list onewaydoors log
Shorts:
Description:	Lists all the rooms in your world with at least one direction where it links to another room, but that room does NOT link back to it. Could be indicative of a problem? Adding a log parameter will dump this list to your mud.log.

LIST POLLS

===LIST POLLS===
Usage:	LIST POLLS
Examples:	list polls
Shorts:
Description:	Lists all the player polls currently defined in the game.

Notes

Use the POLL command to view the results of polls.

LIST QUESTS

===LIST QUESTS===
Usage:	LIST QUESTS
Examples:	list quests
Shorts:
Description:	Lists all the quests being managed by the quest manager, along with the current status of the quest (running, or not), and if it is time-delayed, how long until the quest will attempt to start again.

LIST RACES

===LIST RACES===
Usage:	LIST RACES (SHORT) (MASK) (WIKI/WIKIHELP)
Examples:	list races list races short list races avian list races wiki list races avian wikihelp
Shorts:
Description:	Shows the list of race java classes (race ids) available to archons. Races will have their racial categories shown in () next to the ID. Races with an * next to them are Generic. Adding the short parameter will only show a simple list of race ids. Adding a mask will limit the list to races containing the word.

Notes

• The SHORT parameter will provide a comma delimited list of races (or races meeting a specified mask).
• The MASK parameter should be a racial category, the first few characters of the races name, or the first few characters of a race mix.
  • For example, LIST RACES BEHOLD will display a list of all BEHOLDER racial category races, all races that start with BEHOLD, or any race mixed with a race starting with BEHOLD, such as an AirElementalBeholder or a HalfBeholder.
• The WIKI parameter will output the list with special formatting for easily pasting the list into a wiki page.
• The WIKIHELP parameter will output each ABILITY into specific wiki templates for that ability type.

LIST RACECATS

===LIST RACECATS===
Usage:	LIST RACECATS (SHORT/WIKI)
Examples:	list racecats list racecats short list racecats wiki
Shorts:
Description:	Lists the unique racial categories of all the races in coffeemud. Adding the short parameter will just make the list look different.

Notes

• The SHORT parameter will provide a comma delimited list of classes.
• The WIKI parameter will output the list with special formatting for easily pasting the list into a wiki page.

LIST REALESTATE

===LIST REALESTATE===
Usage:	LIST REALESTATE (/AREA/WORLD) ([OWNER NAME])
Examples:	list realestate list realestate world bob list realestate area bog
Shorts:
Description:	Lists all the rooms for sale in the current area, along with the current name of the room, the current owner (if any) and the price.

Notes

This is a very helpful command to help players find their way back to the properties that they have purchased.

LIST REPORTS

===LIST REPORTS===
Usage:	LIST REPORTS
Examples:	list reports
Shorts:
Description:	Shows a brief report on resource usage of your mud, such as memory, total cpu times, average cpu times for ticking objects, number of tick groups and ticking objects, etc. It will also enumerate the several main service threads of the mud, and show their status as well.

LIST RESOURCES

===LIST RESOURCES===
Usage:	LIST RESOURCES ([MASK])
Examples:	list resources list resources dragons den
Shorts:
Description:	Lists all the cached binary and text data objects in your mud. This will include stuff like parsed MOBPROG programs, MOBPROG variables, text files, help files, area statistics, and so forth. Adding a mask parameter will limit the view of resources only to those with those keywords.

Notes

This is a system resources list. For material resources, use LIST ENVRESOURCES.

LIST ROOMS

===LIST ROOMS===
Usage:	LIST ROOMS
Examples:	list rooms
Shorts:
Description:	Lists all the rooms in the current area, along with the short display name of each room.

Notes

• For LIST ROOMTYPES use LIST LOCALES instead. It will display all room types and locales.

LIST SESSIONS

===LIST SESSIONS===
Usage:	LIST SESSIONS (STATUS/VALID/NAME/IP/IDLE)
Examples:	list sessions list sessions name
Shorts:
Description:	Lists the players online, their idle time, status, and ip address. An optional parameter may be given to sort by one of the fields.

Notes

LIST SESSIONS now has an added column for determining which host of a multi-mud a player has logged in to. For CoffeeMUD, 0 is port 23/2323 (normal), 1 is port 2324 (PK), 2 is port 2325 (HC) and 3 is port 2326 (RP).

LIST STAFF

===LIST STAFF===
Usage:	LIST STAFF
Examples:	list staff
Shorts:
Description:	Lists all the areas, along with any Area SubOps defined for those areas.

LIST THREADS

===LIST THREADS===
Usage:	LIST THREADS (SHORT) (EXTEND)
Examples:	list threads list threads short
Shorts:
Description:	Lists all the threads running in the mud, along with what they are doing, if that information is available. Threads are generally idle, so that should be reflected most of the time. The short parameter will filter out those threads sleeping, waiting, or parked in an executor. The extend parameter will show a little more information about the thread.

LIST TICKS

===LIST TICKS===
Usage:	LIST TICKS ([GROUP NUMBER]/ACTIVE/PROBLEMS/[MASK]) (COL)
Examples:	list ticks list ticks 7 list ticks active list ticks problems
Shorts:
Description:	Shows the list of ticking objects in the game. A ticking object is simply one that may get thread time at some point from the engine. By default, each entry consists of a group id, the name of the object that is ticking, the ID of the tick-type, and a status or ! if the object is not ticking. Valid parameters include a tick group number, the word "active" to only show ticks that are currently receiving thread time, "problems" to receive a list of the ticks that have consumed the most average thread time, or a string mask to filter by object name. The last column of each report may be replaced by adding a valid column name to the end of the list command. Valid columns include: tickername, tickerid, tickerstatus, tickerstatusstr, tickercodeword, tickertickdown, tickerretickdown, tickermillitotal, tickermilliavg, tickerlaststartmillis, tickerlaststopmillis,tickerlaststartdate, tickerlaststopdate, tickerlastduration, tickersuspended.

LIST TITLES

===LIST TITLES===
Usage:	LIST TITLES
Examples:	list titles
Shorts:
Description:	Lists all the auto-applied player titles defined in your game, along with the requirements, that is, the trigger, that will make them available.

LIST UNLINKEDEXITS

===LIST UNLINKEDEXITS===
Usage:	LIST UNLINKEDEXITS (LOG)
Examples:	List unlinkedexits list unlinkedexits log
Shorts:
Description:	Lists all the rooms which have directions for which an exit has been defined, but does not link to any room. Adding the log parameter will dump all that stuff to your mud.log

LIST USERS

===LIST USERS===
Usage:	LIST USERS (COLUMN NAME)
Examples:	list users list users ip
Shorts:
Description:	Lists all the players in your game database, showing by default their race, current class, level, hours played, last login time/date, and name. If you specify a column name of NAME, CLASS, RACE, LEVEL, AGE, LAST, EMAIL, or IP, then that column will be shown if it is not available, and the list will be sorted by that column.

Notes

.