diff options
Diffstat (limited to 'deps/sol2/docs/source/api/userdata.rst')
| -rw-r--r-- | deps/sol2/docs/source/api/userdata.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/deps/sol2/docs/source/api/userdata.rst b/deps/sol2/docs/source/api/userdata.rst new file mode 100644 index 0000000..173e3e7 --- /dev/null +++ b/deps/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. |