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

Clarified some inlinefunc docs.

Browse source
This commit is contained in:
Griatch 2015-10-20 23:49:48 +02:00
parent 3188f89e47
commit 23bfa1f84e
2 changed files with 16 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

21
evennia/game_template/server/conf/inlinefunc.py
View file

@ -26,17 +26,26 @@ Example 2 (using "pad" and "time" inlinefuncs):
To add more inline functions, add them to this module, using To add more inline functions, add them to this module, using
the following call signature: the following call signature:
def funcname(text, *args) def funcname(text, *args, **kwargs)
where the text is always the part between {funcname(args) and where `text` is always the part between {funcname(args) and
{/funcname and the *args are taken from the appropriate part of the {/funcname and the *args are taken from the appropriate part of the
call. It is important that the inline function properly clean the call. If no {/funcname is given, `text` will be the empty string.
incoming args, checking their type and replacing them with sane
It is important that the inline function properly clean the
incoming `args`, checking their type and replacing them with sane
defaults if needed. If impossible to resolve, the unmodified text defaults if needed. If impossible to resolve, the unmodified text
should be returned. The inlinefunc should never cause a traceback. should be returned. The inlinefunc should never cause a traceback.
While the inline function should accept **kwargs, the keyword is
never accepted as a valid call - this is only intended to be used
internally by Evennia, notably to send the `session` keyword to
the function; this is the session of the object viewing the string
and can be used to customize it to each session.
""" """
#def capitalize(text, *args): #def capitalize(text, *args, **kwargs):
# "Silly capitalize example" # "Silly capitalize example. Used as {capitalize() ... {/capitalize"
# session = kwargs.get("session")
# return text.capitalize() # return text.capitalize()

2
evennia/utils/inlinefunc.py
View file

@ -32,7 +32,7 @@ Example:
An inline function should have the following call signature: An inline function should have the following call signature:
def funcname(text, *args) def funcname(text, *args, **kwargs)
where the text is always the part between {funcname(args) and where the text is always the part between {funcname(args) and
{/funcname and the *args are taken from the appropriate part of the {/funcname and the *args are taken from the appropriate part of the