diff options
Diffstat (limited to 'deps/sol2/docs/source/api/metatable_key.rst')
| -rw-r--r-- | deps/sol2/docs/source/api/metatable_key.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/deps/sol2/docs/source/api/metatable_key.rst b/deps/sol2/docs/source/api/metatable_key.rst new file mode 100644 index 0000000..7eeff47 --- /dev/null +++ b/deps/sol2/docs/source/api/metatable_key.rst @@ -0,0 +1,16 @@ +metatable_key
+=============
+*a key for setting and getting an object's metatable*
+
+
+.. code-block:: cpp
+
+ struct metatable_key_t {};
+ const metatable_key_t metatable_key;
+
+You can use this in conjunction with :doc:`sol::table<table>` to set/get a metatable. Lua metatables are powerful ways to override default behavior of objects for various kinds of operators, among other things. Here is an entirely complete example, showing getting and working with a :doc:`usertype<usertype>`'s metatable defined by sol:
+
+.. literalinclude:: ../../../examples/source/metatable_key_low_level.cpp
+ :caption: messing with metatables
+ :name: sol-metatable_key-eg
+ :linenos:
|