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

More updates to doc, to make it compile properly for reST

Browse source
This commit is contained in:
Griatch 2015-05-15 15:26:05 +02:00
parent 105ad5b9f9
commit 809116aabc
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
evennia/utils/batchprocessors.py
View file

@ -109,16 +109,16 @@ as automatic deletion of created objects etc. You can however also run
a batch-code Python file directly using Python. a batch-code Python file directly using Python.
Code blocks are separated by python comments starting with special Code blocks are separated by python comments starting with special
code words. code words:
`#HEADER` - this denotes commands global to the entire file, such as HEADER - this denotes commands global to the entire file, such as
import statements and global variables. They will import statements and global variables. They will
automatically be pasted at the top of all code automatically be pasted at the top of all code
blocks. Observe that changes to these variables made in one blocks. Observe that changes to these variables made in one
block is not preserved between blocks! block is not preserved between blocks!
`#CODE` CODE
`#CODE` (info) CODE (info)
`#CODE` (info) objname1, objname1, ... - CODE (info) objname1, objname1, ... -
This designates a code block that will be executed like a This designates a code block that will be executed like a
stand-alone piece of code together with any #HEADER stand-alone piece of code together with any #HEADER
defined. (info) text is used by the interactive mode to defined. (info) text is used by the interactive mode to
@ -129,7 +129,7 @@ code words.
command myobj = create.create_object(...), you could put command myobj = create.create_object(...), you could put
'myobj' in the #CODE header regardless of what the created 'myobj' in the #CODE header regardless of what the created
object is actually called in-game. object is actually called in-game.
`#INSERT` path.filename - This imports another batch_code.py file and INSERT path.filename - This imports another batch_code.py file and
runs it in the given position. paths are given as python runs it in the given position. paths are given as python
path. The inserted file will retain its own HEADERs which path. The inserted file will retain its own HEADERs which
will not be mixed with the HEADERs of the file importing will not be mixed with the HEADERs of the file importing