aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sol2/docs/source/api/variadic_results.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/variadic_results.rst
parente9758416b18b27a65337c28d9641afc0ee89b34b (diff)
parent7a46fa2dd3dad3f038bf8e7339bc67abca428ae6 (diff)
Started creating scripting library/namespace and added sol2 for interfacing
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