diff options
| author | rubenwardy <rw@rubenwardy.com> | 2018-04-06 09:52:29 +0100 |
|---|---|---|
| committer | Loïc Blot <nerzhul@users.noreply.github.com> | 2018-04-06 10:52:29 +0200 |
| commit | 91615f9588420fd716978552fdacf1323b8df11c (patch) | |
| tree | 951b1c139c09056d0d31bc4b8e0d13fd2d69c8bb /doc | |
| parent | 7e3f88f539109955b21a129e4203a1cadb913483 (diff) | |
| download | minetest-91615f9588420fd716978552fdacf1323b8df11c.tar.gz minetest-91615f9588420fd716978552fdacf1323b8df11c.tar.bz2 minetest-91615f9588420fd716978552fdacf1323b8df11c.zip | |
Add player:get_meta(), deprecate player attributes (#7202)
* Add player:get_meta(), deprecate player attributes
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lua_api.txt | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt index ea8e8b254..620828824 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -3902,7 +3902,7 @@ An interface to use mod channels on client and server * Message size is limited to 65535 characters by protocol. ### `MetaDataRef` -See `StorageRef`, `NodeMetaRef` and `ItemStackMetaRef`. +See `StorageRef`, `NodeMetaRef`, `ItemStackMetaRef`, and `PlayerMetaRef`. #### Methods * `set_string(name, value)` @@ -3952,6 +3952,15 @@ Can be obtained via `minetest.get_mod_storage()` during load time. #### Methods * All methods in MetaDataRef +### `PlayerMetaRef` +Player metadata. +Uses the same method of storage as the deprecated player attribute API, so +data there will also be in player meta. +Can be obtained using `player:get_meta()`. + +#### Methods +* All methods in MetaDataRef + ### `NodeTimerRef` Node Timers: a high resolution persistent per-node timer. Can be gotten via `minetest.get_node_timer(pos)`. @@ -4101,14 +4110,15 @@ This is basically a reference to a C++ `ServerActiveObject` * `0`: player is drowning * max: bubbles bar is not shown * See Object Properties for more information -* `set_attribute(attribute, value)`: +* `set_attribute(attribute, value)`: DEPRECATED, use get_meta() instead * Sets an extra attribute with value on player. * `value` must be a string, or a number which will be converted to a string. * If `value` is `nil`, remove attribute from player. -* `get_attribute(attribute)`: +* `get_attribute(attribute)`: DEPRECATED, use get_meta() instead * Returns value (a string) for extra attribute. * Returns `nil` if no attribute found. +* `get_meta()`: Returns a PlayerMetaRef. * `set_inventory_formspec(formspec)` * Redefine player's inventory form * Should usually be called in `on_joinplayer` |