From 217f3a42f48f729f0977338bdfaa1be019fe76e9 Mon Sep 17 00:00:00 2001 From: sfan5 Date: Wed, 12 Feb 2020 22:24:47 +0100 Subject: [PATCH] Documentation: More precise description of ObjectRef:remove() --- doc/lua_api.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) 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)` -- 2.25.1