sol2/docs/source/api/api-top.rst

api reference manual
====================

Browse the various function and classes :doc:`Sol<../index>` utilizes to make your life easier when working with Lua.


.. toctree::
   :caption: Sol API
   :name: apitoc
   :maxdepth: 2

   compatibility
   coroutine
   c_call
   error
   function
   protected_function
   object
   reference
   stack_reference
   make_reference
   overload
   protect
   readonly
   var
   resolve
   as_function
   property
   proxy
   stack
   optional
   state
   table
   as_table
   metatable_key
   this_state
   thread
   tie
   types
   user
   usertype
   simple_usertype
   userdata
   usertype_memory
   unique_usertype_traits
   variadic_args
The docs are here. 2016-03-12 06:47:15 +08:00			`api reference manual`
			`====================`

			Browse the various function and classes :doc:`Sol<../index>` utilizes to make your life easier when working with Lua.


			`.. toctree::`
			`:caption: Sol API`
			`:name: apitoc`
V E T T E D Slight breaking change, but at the source level almost nothing changes (ipairs is the only thing that changes because for some reason it checks if what is passed is a table and that really doesn't make any fucking sense) Closes #195 Closes #196 2016-08-24 09:42:27 +08:00			`:maxdepth: 2`
The docs are here. 2016-03-12 06:47:15 +08:00
			`compatibility`
			`coroutine`
Formally introduce `c_call` to the API with overloading ability More documentation on how things work. Once more at a 'feature-complete' state. Continue to work on #116. Add testcase to ensure #108 is fixed. Then, prep release. 2016-06-18 15:32:54 +08:00			`c_call`
The docs are here. 2016-03-12 06:47:15 +08:00			`error`
			`function`
			`protected_function`
			`object`
Maximum the features. 2016-06-20 21:51:26 +08:00			`reference`
			`stack_reference`
			`make_reference`
The docs are here. 2016-03-12 06:47:15 +08:00			`overload`
protect could use some additional optimizations for space, but I'm kinna tired. 2016-07-09 15:43:51 +08:00			`protect`
			`readonly`
[ci-skip] docs update 2016-08-08 02:21:59 +08:00			`var`
Documents nullptr (Closes #159) Documents callable structures and the function to use with `table.set` if needed (Closes #162) 2016-08-06 12:30:35 +08:00			`resolve`
			`as_function`
Shiny quick 'n' dirty tutorial -- variadic_args now is iterable -- fixed bug with transparent args in overload resolution -- added `load` functions 2016-04-24 05:07:51 +08:00			`property`
The docs are here. 2016-03-12 06:47:15 +08:00			`proxy`
			`stack`
documentation cleanup 2016-03-25 22:58:33 +08:00			`optional`
The docs are here. 2016-03-12 06:47:15 +08:00			`state`
			`table`
[ci skip] update info 2016-08-24 21:17:26 +08:00			`as_table`
This commit adds some QoI constructor keys / types, as well as implements `make_object`. The documentation has been updated as well. Closes #78 Closes #77 Closes #76 Closes #75 2016-05-04 02:19:30 +08:00			`metatable_key`
Shiny quick 'n' dirty tutorial -- variadic_args now is iterable -- fixed bug with transparent args in overload resolution -- added `load` functions 2016-04-24 05:07:51 +08:00			`this_state`
The docs are here. 2016-03-12 06:47:15 +08:00			`thread`
Update version numbers, fix tests, and change bond -> tie, since nobody understands what bond means 2016-04-24 22:09:05 +08:00			`tie`
The docs are here. 2016-03-12 06:47:15 +08:00			`types`
Documentation updates -- require function and add function and size function needed documentation New `add` function as requested by @EliasD 2016-06-20 05:59:40 +08:00			`user`
The docs are here. 2016-03-12 06:47:15 +08:00			`usertype`
Usertype documentation 2016-07-08 06:11:03 +08:00			`simple_usertype`
The docs are here. 2016-03-12 06:47:15 +08:00			`userdata`
documentation fixes from feedback and fixes! 2016-03-14 14:34:02 +08:00			`usertype_memory`
:l Stop finding bugs in my code -- unique_usertype_traits implemented, sol::overloaded work for static functions 2016-04-24 13:39:44 +08:00			`unique_usertype_traits`
Shiny quick 'n' dirty tutorial -- variadic_args now is iterable -- fixed bug with transparent args in overload resolution -- added `load` functions 2016-04-24 05:07:51 +08:00			`variadic_args`