aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sol2/docs/source/api/variadic_results.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/variadic_results.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/variadic_results.rst')
-rw-r--r--lib/sol2/docs/source/api/variadic_results.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/sol2/docs/source/api/variadic_results.rst b/lib/sol2/docs/source/api/variadic_results.rst
new file mode 100644
index 0000000..39067e1
--- /dev/null
+++ b/lib/sol2/docs/source/api/variadic_results.rst
@@ -0,0 +1,11 @@
+variadic_results
+================
+*push multiple disparate arguments into lua*
+
+.. code-block:: cpp
+
+ struct variadic_results : std::vector<object> { ... };
+
+This type allows someone to prepare multiple returns before returning them into Lua. It derives from ``std::vector``, so it can be used exactly like that, and objects can be added using the various constructors and functions relating to :doc:`sol::object<object>`. You can see it and other return-type helpers in action `here`_.
+
+.. _here: https://github.com/ThePhD/sol2/blob/develop/examples/source/multi_results.cpp