aboutsummaryrefslogtreecommitdiffstats
path: root/deps/sol2/docs/source/api/this_state.rst
diff options
context:
space:
mode:
authorAndy Belle-Isle <drumsetmonkey@gmail.com>2019-08-30 00:19:31 -0400
committerAndy Belle-Isle <drumsetmonkey@gmail.com>2019-08-30 00:19:31 -0400
commitbd3fe0cac583739bc0d7c4b5c8f301bb350abca0 (patch)
tree7eeb1aabcebd6999de1c3457d0882246ec0ff4d4 /deps/sol2/docs/source/api/this_state.rst
parent2662ac356ce14dacfbc91689fd37244facff4989 (diff)
Renamed lib to deps so github will ignore it for language stats
Diffstat (limited to 'deps/sol2/docs/source/api/this_state.rst')
-rw-r--r--deps/sol2/docs/source/api/this_state.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/deps/sol2/docs/source/api/this_state.rst b/deps/sol2/docs/source/api/this_state.rst
new file mode 100644
index 0000000..46eec7b
--- /dev/null
+++ b/deps/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: