diff options
author | Andy <drumsetmonkey@gmail.com> | 2019-08-29 13:07:45 -0400 |
---|---|---|
committer | Andy <drumsetmonkey@gmail.com> | 2019-08-29 13:07:45 -0400 |
commit | 4ac4b280abf2ffa28caa5a532353115a3033444f (patch) | |
tree | 2a13d658bb454360b2faf401244bb0321d3460d4 /lib/sol2/docs/source/api/userdata.rst | |
parent | e9758416b18b27a65337c28d9641afc0ee89b34b (diff) | |
parent | 7a46fa2dd3dad3f038bf8e7339bc67abca428ae6 (diff) |
Started creating scripting library/namespace and added sol2 for interfacing
Diffstat (limited to 'lib/sol2/docs/source/api/userdata.rst')
-rw-r--r-- | lib/sol2/docs/source/api/userdata.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/sol2/docs/source/api/userdata.rst b/lib/sol2/docs/source/api/userdata.rst new file mode 100644 index 0000000..173e3e7 --- /dev/null +++ b/lib/sol2/docs/source/api/userdata.rst @@ -0,0 +1,12 @@ +userdata +======== +*reference to a userdata* + +.. code-block:: cpp + :caption: (light\_)userdata reference + + class userdata : public table; + + class light_userdata : public table; + +These types are meant to hold a reference to a (light) userdata from Lua and make it easy to push an existing userdata onto the stack. It is essentially identical to :doc:`table<table>` in every way, just with a definitive C++ type that ensures the type is some form of userdata (helpful for trapping type errors with :doc:`safety features turned on<../safety>`). You can also use its ``.is<T>()`` and ``.as<T>()`` methods to check if its of a specific type and retrieve that type, respectively. |