diff options
| author | Clyne Sullivan <clyne@bitgloo.com> | 2022-11-15 07:35:07 -0500 |
|---|---|---|
| committer | Clyne Sullivan <clyne@bitgloo.com> | 2022-11-15 07:35:07 -0500 |
| commit | a056c15dd3781b4f6bb89fdd738b14cafc00cd85 (patch) | |
| tree | 1775a5913c7bc87563b6b4a29c63514cf15b4185 /lib/sol2/docs/source/api/userdata.rst | |
| parent | 1405d648b6264cfda7c46f5b251258335abaee83 (diff) | |
| parent | 57013add5b7c524086272be7d395f9ec5109bde2 (diff) | |
merge branch lib-cleanup into ui
Diffstat (limited to 'lib/sol2/docs/source/api/userdata.rst')
| -rw-r--r-- | lib/sol2/docs/source/api/userdata.rst | 12 |
1 files changed, 0 insertions, 12 deletions
diff --git a/lib/sol2/docs/source/api/userdata.rst b/lib/sol2/docs/source/api/userdata.rst deleted file mode 100644 index 173e3e7..0000000 --- a/lib/sol2/docs/source/api/userdata.rst +++ /dev/null @@ -1,12 +0,0 @@ -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. |