Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Make the EvMenu docs look a little cleaner.

Browse source
This commit is contained in:
Ahmed Charles 2015-10-17 19:44:20 +00:00 • committed by Griatch
parent 53ec675960
commit 5fa9978e1a
1 changed files with 14 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

27
evennia/utils/evmenu.py
View file

@ -54,19 +54,20 @@ The return values must be given in the above order, but each can be
returned as None as well. If the options are returned as None, the returned as None as well. If the options are returned as None, the
menu is immediately exited and the default "look" command is called. menu is immediately exited and the default "look" command is called.
text (str, tuple or None): Text shown at this node. If a tuple, the second text (str, tuple or None): Text shown at this node. If a tuple, the
element in the tuple is a help text to display at this node when second element in the tuple is a help text to display at this
the user enters the menu help command there. node when the user enters the menu help command there.
options (tuple, dict or None): ( {'key': name, # can also be a list of aliases. A special key is "_default", which options (tuple, dict or None): (
# marks this option as the default fallback when no other {'key': name, # can also be a list of aliases. A special key is
# option matches the user input. # "_default", which marks this option as the default
'desc': description, # option description # fallback when no other option matches the user input.
'goto': nodekey, # node to go to when chosen 'desc': description, # optional description
'exec': nodekey, # node or callback to trigger as callback when chosen. If a node 'goto': nodekey, # node to go to when chosen
# key is given the node will be executed once but its return u 'exec': nodekey}, # node or callback to trigger as callback when chosen.
# values are ignored. If a callable is given, it must accept # If a node key is given, the node will be executed once
# one or two args, like any node. # but its return values are ignored. If a callable is
{...}, ...) # given, it must accept one or two args, like any node.
{...}, ...)
If key is not given, the option will automatically be identified by If key is not given, the option will automatically be identified by
its number 1..N. its number 1..N.