Update remove_player documentation
authorShadowNinja <shadowninja@minetest.net>
Sat, 3 Jun 2017 18:39:49 +0000 (14:39 -0400)
committerShadowNinja <shadowninja@minetest.net>
Sat, 3 Jun 2017 18:39:49 +0000 (14:39 -0400)
This function only removes player meta data,
not player authentication data.

doc/lua_api.txt

index 9bf0b551b77f341f123c06350986e8baa832f19d..ddfd0c202969ccecf05250afa266308b9eb74dd4 100644 (file)
@@ -2789,6 +2789,7 @@ These functions return the leftover itemstack.
 * `minetest.get_server_status()`: returns server status string
 * `minetest.get_server_uptime()`: returns the server uptime in seconds
 * `minetest.remove_player(name)`: remove player from database (if he is not connected).
+    * Does not remove player authentication data, minetest.player_exists will continue to return true.
     * Returns a code (0: successful, 1: no such player, 2: player is connected)
 
 ### Bans