Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Simplify the Funcparser page (mostly done already). Resolve #3152.

Browse source
This commit is contained in:
Griatch 2023-08-06 16:49:27 +02:00
parent c113cabeba
commit 4a0e71278d
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/source/Components/FuncParser.md
View file

@ -22,7 +22,7 @@ You say "To get a random value from 1 to 5, use $randint(1,5)."
While `randint` may look and work just like `random.randint` from the standard Python library, it is _not_. Instead it's a `inlinefunc` named `randint` made available to Evennia (which in turn uses the standard library function). For security reasons, only functions explicitly assigned to be used as inlinefuncs are viable.
The `FuncParser` tool is initialized with the inlinefuncs it's supposed to recognize. Below is an example of a parser only only understanding a single `$pow` inlinefunc:
You can apply the `FuncParser` manually. The parser is initialized with the inlinefunc(s) it's supposed to recognize in that string. Below is an example of a parser only understanding a single `$pow` inlinefunc:
```python
from evennia.utils.funcparser import FuncParser
@ -50,6 +50,8 @@ parser.parse_to_any("$pow(4)")
16
```
You don't have to define all your inline functions from scratch. In `evennia.utils.funcparser` you'll find ready-made dicts of inline-funcs you can import and plug into your parsers. See [default funcparser callables](#default-funcparser-callables) below for the defails.
## Working with FuncParser
The FuncParser can be applied to any string. Out of the box it's applied in a few situations: