From dc2493e7525bb7633f697ef10f72b72b46222249 Mon Sep 17 00:00:00 2001 From: Andy Belle-Isle Date: Fri, 30 Aug 2019 00:45:36 -0400 Subject: Forget what I said, I just need to change git attributes to mark for vendor --- lib/sol2/docs/source/api/this_state.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 lib/sol2/docs/source/api/this_state.rst (limited to 'lib/sol2/docs/source/api/this_state.rst') 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` on this type. It can be put in any position in the argument list of a function: + +.. literalinclude:: ../../../examples/source/this_state.cpp + :linenos: -- cgit v1.2.3