Use "group" instead of "category"
[mudpy.git] / share / command.yaml
1 _copy: Copyright (c) 2004-2017 Jeremy Stanley <fungi@yuggoth.org>.
2     Permission to use, copy, modify, and distribute this software is granted
3     under terms provided in the LICENSE file distributed with this software.
4
5 _desc: This is the standard library of command definitions.
6
7 _lock: true
8
9 command.chat.action: command_chat(actor)
10 command.chat.description: Enter and leave chat mode.
11 command.chat.help: The chat command toggles chat mode. When in chat mode, all input is passed as a parameter to the say command, unless prepended by an exclamation mark (!). For example, to leave chat mode, use:$(eol)$(eol)   !chat
12 command.chat.see_also: say
13
14 command.create.action: command_create(actor, parameters)
15 command.create.administrative: true
16 command.create.description: Create a new element in the universe.
17 command.create.help: Ways to create an element:$(eol)$(eol)   create actor:fred$(eol)   create other:garply foo/bar/baz
18
19 command.delete.action: command_delete(actor, parameters)
20 command.delete.administrative: true
21 command.delete.description: Delete an existing facet from an element.
22 command.delete.help: You can delete any facet of an element as follows:$(eol)$(eol)   delete area:boardroom terrain
23
24 command.destroy.action: command_destroy(actor, parameters)
25 command.destroy.administrative: true
26 command.destroy.description: Destroy an existing element in the universe.
27 command.destroy.help: You can destroy any element in the universe as follows:$(eol)$(eol)   destroy prop:dagger
28
29 command.halt.action: command_halt(actor, parameters)
30 command.halt.administrative: true
31 command.halt.description: Shut down the world.
32 command.halt.help: This will save all active accounts, disconnect all clients and stop the entire program.
33
34 command.help.action: command_help(actor, parameters)
35 command.help.description: List commands or get help on one.
36 command.help.help: This will list all comand words available to you along with a brief description or, alternatively, give you detailed information on one command.
37
38 command.look.action: command_look(actor, parameters)
39 command.look.description: Look around.
40 command.look.help: With the look command, you can see where you are.
41
42 command.move.action: command_move(actor, parameters)
43 command.move.description: Move in a specific direction.
44 command.move.help: You move in a direction by entering:$(eol)$(eol)   move north
45
46 command.quit.action: command_quit(actor)
47 command.quit.description: Leave the World.
48 command.quit.help: This will deactivate your avatar and return you to the main menu.
49
50 command.reload.action: command_reload(actor)
51 command.reload.administrative: true
52 command.reload.description: Reload modules and data.
53 command.reload.help: This will reload all python modules and read-only data files.
54
55 command.say.action: command_say(actor, parameters)
56 command.say.description: State something out loud.
57 command.say.help: This allows you to speak to other characters within the same area. If you end your sentence with punctuation, the message displayed will incorporate an appropriate action (ask, exclaim, et cetera). It will also correct common typographical errors, add punctuation and capitalize your sentence as needed (assuming you speak one sentence per line). For example:$(eol)$(eol)   > say youre sure i went teh wrong way?$(eol)   You ask, "You're sure I went the wrong way?"$(eol)$(eol)If necessary, enclose literal statements in quotation marks:$(eol)$(eol)   > say "youre sure i went teh wrong way?"$(eol)   You say, "youre sure i went teh wrong way?"
58 command.say.see_also: chat
59
60 command.set.action: command_set(actor, parameters)
61 command.set.administrative: true
62 command.set.description: Set a facet of an element.
63 command.set.help: Invoke it like this:$(eol)$(eol)   set actor:dominique description You see nothing special.
64
65 command.show.action: command_show(actor, parameters)
66 command.show.administrative: true
67 command.show.description: Show various data.
68 command.show.help: Here are the possible incantations (<parameter> is required, [option] is optional, (note) is a note):$(eol)$(eol)   show groups (list all element group names)$(eol)   show group <group> (list the elements in a group)$(eol)   show element <element> (list facet definitions for an element)$(eol)   show file <filename> (list elements in a file)$(eol)   show files (list all element data files)$(eol)   show log [level [start [stop]]] (list logs above level from start to stop)$(eol)   show result <expression> (evaluates a python expression)$(eol)   show time (returns several current timer values)