From bd3fe0cac583739bc0d7c4b5c8f301bb350abca0 Mon Sep 17 00:00:00 2001 From: Andy Belle-Isle Date: Fri, 30 Aug 2019 00:19:31 -0400 Subject: Renamed lib to deps so github will ignore it for language stats --- deps/sol2/docs/source/api/userdata.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 deps/sol2/docs/source/api/userdata.rst (limited to 'deps/sol2/docs/source/api/userdata.rst') 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` 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()`` and ``.as()`` methods to check if its of a specific type and retrieve that type, respectively. -- cgit v1.2.3