From: Wuzzy <wuzzy2@mail.ru>
Date: Sat, 3 Jun 2017 06:20:22 +0000 (+0200)
Subject: Mention data type for get/set_attribute in docs (#5884)
X-Git-Tag: 0.4.16~46
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=e91ffa0c911557f9f833e7b29066b8d3026751c7;p=oweals%2Fminetest.git

Mention data type for get/set_attribute in docs (#5884)
---

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index e4ffa7bbe..9bf0b551b 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -3217,8 +3217,11 @@ This is basically a reference to a C++ `ServerActiveObject`
         * `11`: bubbles bar is not shown
 * `set_attribute(attribute, value)`:
     * Sets an extra attribute with value on player.
-    * If value is nil, remove attribute from player.
-* `get_attribute(attribute)`: returns value for extra attribute. Returns nil if no attribute found.
+    * `value` must be a string.
+    * If `value` is `nil`, remove attribute from player.
+* `get_attribute(attribute)`:
+    * Returns value (a string) for extra attribute.
+    * Returns `nil` if no attribute found.
 * `set_inventory_formspec(formspec)`
     * Redefine player's inventory form
     * Should usually be called in `on_joinplayer`