diff options
| author | ANAND <ClobberXD@gmail.com> | 2019-07-08 07:57:56 +0530 |
|---|---|---|
| committer | Paramat <paramat@users.noreply.github.com> | 2019-07-08 03:27:56 +0100 |
| commit | 3a8ac9b03199cf0773107e58c69dd078892284a2 (patch) | |
| tree | ae9cca6d7257c89afa58c8fcd306499357c4e1c3 /doc | |
| parent | 9b067efb99c7b8682639736e7c4908b2e3e6e524 (diff) | |
| download | minetest-3a8ac9b03199cf0773107e58c69dd078892284a2.tar.gz minetest-3a8ac9b03199cf0773107e58c69dd078892284a2.tar.bz2 minetest-3a8ac9b03199cf0773107e58c69dd078892284a2.zip | |
Document ObjectRef:remove under Lua entity (#8659)
This was previously documented under the general ObjectRef section with a note that this won't work on players. So I think this would fit better with Lua entity-only methods.
This PR also changes the title of the Lua entity-only section from `LuaEntitySAO-only` to `Lua entity only`.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lua_api.txt | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt index 913ed3aca..b25c4ec9d 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -5263,8 +5263,6 @@ This is basically a reference to a C++ `ServerActiveObject` ### Methods -* `remove()`: remove object (after returning from Lua) - * Note: Doesn't work on players, use `minetest.kick_player` instead * `get_pos()`: returns `{x=num, y=num, z=num}` * `set_pos(pos)`: `pos`=`{x=num, y=num, z=num}` * `move_to(pos, continuous=false)`: interpolated move @@ -5323,8 +5321,9 @@ This is basically a reference to a C++ `ServerActiveObject` text = "My Nametag", } -#### LuaEntitySAO-only (no-op for other objects) +#### Lua entity only (no-op for other objects) +* `remove()`: remove object (after returning from Lua) * `set_velocity(vel)` * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}` * `add_velocity(vel)` @@ -5355,7 +5354,7 @@ This is basically a reference to a C++ `ServerActiveObject` * `get_entity_name()` (**Deprecated**: Will be removed in a future version) * `get_luaentity()` -#### Player-only (no-op for other objects) +#### Player only (no-op for other objects) * `get_player_name()`: returns `""` if is not a player * `get_player_velocity()`: returns `nil` if is not a player, otherwise a |