mtcontrib
/
Minetest-WorldEdit
mirror of https://github.com/Uberi/Minetest-WorldEdit.git
1
0
Fork 1
Code Issues Releases Wiki Activity

doc updated

This commit is contained in:
Imre Péntek 2024-04-16 00:38:50 +02:00
parent 73b9cd1776
commit ea05043273
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
WorldEdit API.md
View File

@ -227,9 +227,9 @@ Code
----
Contained in code.lua, this module allows arbitrary Lua code to be used with WorldEdit.
### error = worldedit.lua(code,name)
### error = worldedit.lua(code, name)
the given code gets encapsulated into a function with parameters `name`, `player`, pos`
the given code gets encapsulated into a function with parameters `name`, `player`, `pos`
where
* `name` is a playername or `nil`
* `player` is the player object of the above player if applicable, otherwise `nil`
@ -237,7 +237,9 @@ where
the resulting function is then executed as a Lua chunk in the global namespace.
The return is a tuple of success and return of the function converted to a string, which in turn serves as an error messsage in case of a failure
The return is
* a string in case of an error
* a tuple of `nil` and return of the function converted to a string in case of success
### error = worldedit.luatransform(pos1, pos2, code)