diff options
| author | sfan5 <sfan5@live.de> | 2020-02-12 22:24:47 +0100 |
|---|---|---|
| committer | sfan5 <sfan5@live.de> | 2020-02-23 22:24:12 +0100 |
| commit | 217f3a42f48f729f0977338bdfaa1be019fe76e9 (patch) | |
| tree | 1a6d9eb84154adb776293044f60655e5485c20f8 /doc | |
| parent | 2bb7d3aa99ea395288f6be808086428b41e3f714 (diff) | |
| download | minetest-217f3a42f48f729f0977338bdfaa1be019fe76e9.tar.gz minetest-217f3a42f48f729f0977338bdfaa1be019fe76e9.tar.bz2 minetest-217f3a42f48f729f0977338bdfaa1be019fe76e9.zip | |
Documentation: More precise description of ObjectRef:remove()
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lua_api.txt | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt index a16c083c8..b87353b6a 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -5778,7 +5778,10 @@ This is basically a reference to a C++ `ServerActiveObject` #### Lua entity only (no-op for other objects) -* `remove()`: remove object (after returning from Lua) +* `remove()`: remove object + * The object is removed after returning from Lua. However the `ObjectRef` + itself instantly becomes unusable with all further method calls having + no effect and returning `nil`. * `set_velocity(vel)` * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}` * `add_velocity(vel)` |