aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sol2/docs/source/api/this_state.rst
diff options
context:
space:
mode:
authorAndy <drumsetmonkey@gmail.com>2019-08-29 13:07:45 -0400
committerAndy <drumsetmonkey@gmail.com>2019-08-29 13:07:45 -0400
commit4ac4b280abf2ffa28caa5a532353115a3033444f (patch)
tree2a13d658bb454360b2faf401244bb0321d3460d4 /lib/sol2/docs/source/api/this_state.rst
parente9758416b18b27a65337c28d9641afc0ee89b34b (diff)
parent7a46fa2dd3dad3f038bf8e7339bc67abca428ae6 (diff)
Started creating scripting library/namespace and added sol2 for interfacing
Diffstat (limited to 'lib/sol2/docs/source/api/this_state.rst')
-rw-r--r--lib/sol2/docs/source/api/this_state.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/sol2/docs/source/api/this_state.rst b/lib/sol2/docs/source/api/this_state.rst
new file mode 100644
index 0000000..46eec7b
--- /dev/null
+++ b/lib/sol2/docs/source/api/this_state.rst
@@ -0,0 +1,13 @@
+this_state
+==========
+*transparent state argument for the current state*
+
+
+.. code-block:: cpp
+
+ struct this_state;
+
+This class is a transparent type that is meant to be gotten in functions to get the current lua state a bound function or usertype method is being called from. It does not actually retrieve anything from lua nor does it increment the argument count, making it "invisible" to function calls in lua and calls through ``std::function<...>`` and :doc:`sol::function<function>` on this type. It can be put in any position in the argument list of a function:
+
+.. literalinclude:: ../../../examples/source/this_state.cpp
+ :linenos: