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