Add player:get_meta(), deprecate player attributes (#7202)
[oweals/minetest.git] / src / script / lua_api / l_playermeta.h
1 /*
2 Minetest
3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4 Copyright (C) 2017-8 rubenwardy <rw@rubenwardy.com>
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 GNU Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 */
20
21 #pragma once
22
23 #include "lua_api/l_base.h"
24 #include "lua_api/l_metadata.h"
25 #include "irrlichttypes_bloated.h"
26 #include "inventory.h"
27 #include "metadata.h"
28
29 class PlayerMetaRef : public MetaDataRef
30 {
31 private:
32         Metadata *metadata = nullptr;
33
34         static const char className[];
35         static const luaL_Reg methods[];
36
37         static PlayerMetaRef *checkobject(lua_State *L, int narg);
38
39         virtual Metadata *getmeta(bool auto_create);
40
41         virtual void clearMeta();
42
43         virtual void reportMetadataChange();
44
45         // garbage collector
46         static int gc_object(lua_State *L);
47
48 public:
49         PlayerMetaRef(Metadata *metadata) : metadata(metadata) {}
50         ~PlayerMetaRef() = default;
51
52         // Creates an ItemStackMetaRef and leaves it on top of stack
53         // Not callable from Lua; all references are created on the C side.
54         static void create(lua_State *L, Metadata *metadata);
55
56         static void Register(lua_State *L);
57 };