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

[dragonfireclient.git] / doc / lua_api.txt

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index e4ffa7bbe3c618f8f0194e48e7b68cc0e9e2470c..9bf0b551b77f341f123c06350986e8baa832f19d 100644 (file)
--- 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`