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

This commit is contained in:
Wuzzy 2017-06-03 08:20:22 +02:00 committed by Loïc Blot
parent 1b83b0acfd
commit e91ffa0c91

@ -3217,8 +3217,11 @@ This is basically a reference to a C++ `ServerActiveObject`
* `11`: bubbles bar is not shown * `11`: bubbles bar is not shown
* `set_attribute(attribute, value)`: * `set_attribute(attribute, value)`:
* Sets an extra attribute with value on player. * Sets an extra attribute with value on player.
* If value is nil, remove attribute from player. * `value` must be a string.
* `get_attribute(attribute)`: returns value for extra attribute. Returns nil if no attribute found. * 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)` * `set_inventory_formspec(formspec)`
* Redefine player's inventory form * Redefine player's inventory form
* Should usually be called in `on_joinplayer` * Should usually be called in `on_joinplayer`