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

Fix order of args for the callback in documentation

Browse source
This commit is contained in:
FlutterSprite 2017-11-12 02:21:49 -08:00 • committed by GitHub
parent 4a554a4409
commit ebe7c6f4b3
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
evennia/contrib/tree_select.py
View file

@ -131,7 +131,7 @@ Now we see that the Baz option has a description attached that's separate from i
Once the player makes a selection - let's say, 'Foo' - the menu will terminate and call Once the player makes a selection - let's say, 'Foo' - the menu will terminate and call
your specified callback with the selection, like so: your specified callback with the selection, like so:
callback(TEST_MENU, caller, 0, "Foo") callback(caller, TEST_MENU, 0, "Foo")
The index of the selection is given along with a string containing the selection's key. The index of the selection is given along with a string containing the selection's key.
That way, if you have two selections in the menu with the same key, you can still That way, if you have two selections in the menu with the same key, you can still
@ -171,8 +171,8 @@ def init_tree_selection(treestr, caller, callback,
treestr (str): Multi-lne string representing menu options treestr (str): Multi-lne string representing menu options
caller (obj): Player to initialize the menu for caller (obj): Player to initialize the menu for
callback (callable): Function to run when a selection is made. Must take 4 args: callback (callable): Function to run when a selection is made. Must take 4 args:
treestr (str): Menu tree string given above
caller (obj): Caller given above caller (obj): Caller given above
treestr (str): Menu tree string given above
index (int): Index of final selection index (int): Index of final selection
selection (str): Key of final selection selection (str): Key of final selection