aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sol2/docs/source/api/var.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/var.rst
parente9758416b18b27a65337c28d9641afc0ee89b34b (diff)
parent7a46fa2dd3dad3f038bf8e7339bc67abca428ae6 (diff)
Started creating scripting library/namespace and added sol2 for interfacing
Diffstat (limited to 'lib/sol2/docs/source/api/var.rst')
-rw-r--r--lib/sol2/docs/source/api/var.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/sol2/docs/source/api/var.rst b/lib/sol2/docs/source/api/var.rst
new file mode 100644
index 0000000..0c6d442
--- /dev/null
+++ b/lib/sol2/docs/source/api/var.rst
@@ -0,0 +1,9 @@
+var
+===
+*For hooking up static / global variables to Lua usertypes*
+
+
+The sole purpose of this tagging type is to work with :doc:`usertypes<usertype>` to provide ``my_class.my_static_var`` access, and to also provide reference-based access as well.
+
+.. literalinclude:: ../../../examples/source/usertype_var.cpp
+ :linenos: