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

Update evmenu docstring.

Browse source
This commit is contained in:
Griatch 2017-01-21 23:06:56 +01:00
parent 0aebbf6975
commit ae3af20cd7
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
evennia/utils/evmenu.py
View file

@ -70,15 +70,17 @@ menu is immediately exited and the default "look" command is called.
# "_default", which marks this option as the default # "_default", which marks this option as the default
# fallback when no other option matches the user input. # fallback when no other option matches the user input.
'desc': description, # optional description 'desc': description, # optional description
'goto': nodekey, # node to go to when chosen 'goto': nodekey, # node to go to when chosen. This can also be a callable with
# caller and/or raw_string args. It must return a string
# with the key pointing to the node to go to.
'exec': nodekey}, # node or callback to trigger as callback when chosen. This 'exec': nodekey}, # node or callback to trigger as callback when chosen. This
# will execute *before* going to the next node. Both node # will execute *before* going to the next node. Both node
# and the explicit callback will be called as normal nodes # and the explicit callback will be called as normal nodes
# (with caller and/or raw_string args). If the callable/node # (with caller and/or raw_string args). If the callable/node
# returns a single string (only), this will replace the current # returns a single string (only), this will replace the current
# goto location string in-place. Note that relying to # goto location string in-place (if a goto callback, it will never fire).
# much on letting exec assign the goto location can make it # Note that relying to much on letting exec assign the goto
# hard to debug your menu logic. # location can make it hard to debug your menu logic.
{...}, ...) {...}, ...)
If key is not given, the option will automatically be identified by If key is not given, the option will automatically be identified by