Skip to content
Permalink
Browse files

Documentation: More precise description of ObjectRef:remove()

  • Loading branch information
sfan5 committed Feb 23, 2020
1 parent 2bb7d3a commit 217f3a42f48f729f0977338bdfaa1be019fe76e9
Showing with 4 additions and 1 deletion.
  1. +4 −1 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)`

0 comments on commit 217f3a4

Please sign in to comment.
You can’t perform that action at this time.