aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sol2/docs/source/api/userdata.rst
diff options
context:
space:
mode:
authorAndy Belle-Isle <drumsetmonkey@gmail.com>2019-08-30 00:45:36 -0400
committerAndy Belle-Isle <drumsetmonkey@gmail.com>2019-08-30 00:45:36 -0400
commitdc2493e7525bb7633f697ef10f72b72b46222249 (patch)
tree9816755219e65d3f47fdce81c78f3736a7ddb8ab /lib/sol2/docs/source/api/userdata.rst
parent9d2b31797d0cfd130802b69261df2cd402e39b49 (diff)
Forget what I said, I just need to change git attributes to mark for vendor
Diffstat (limited to 'lib/sol2/docs/source/api/userdata.rst')
-rw-r--r--lib/sol2/docs/source/api/userdata.rst12
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.