aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sol2/docs/source/api/var.rst
diff options
context:
space:
mode:
authorAndy Belle-Isle <drumsetmonkey@gmail.com>2019-08-30 00:45:36 -0400
committerAndy Belle-Isle <drumsetmonkey@gmail.com>2019-08-30 00:45:36 -0400
commitdc2493e7525bb7633f697ef10f72b72b46222249 (patch)
tree9816755219e65d3f47fdce81c78f3736a7ddb8ab /lib/sol2/docs/source/api/var.rst
parent9d2b31797d0cfd130802b69261df2cd402e39b49 (diff)
Forget what I said, I just need to change git attributes to mark for vendor
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: