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

   state
   this_state
   reference
   stack_reference
   make_reference
   table
   userdata
   environment
   this_environment
   proxy
   containers
   nested
   as_table
   usertype
   simple_usertype
   usertype_memory
   unique_usertype_traits
   tie
   function
   protected_function
   coroutine
   error
   object
   thread
   optional
   variadic_args
   as_args
   overload
   property
   var
   protect
   readonly
   as_function
   c_call
   resolve
   stack
   user
   compatibility
   types
   metatable_key
   new_table
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
balance that stack, goddamnit, BALANCE IT 2016-09-20 11:37:00 +08:00			`state`
this_environment is now live 2017-05-10 01:24:56 +08:00			`this_state`
New feature: environment plus documentation about the environment table and its usage with scripts. 2017-04-03 04:10:00 +08:00			`reference`
			`stack_reference`
			`make_reference`
balance that stack, goddamnit, BALANCE IT 2016-09-20 11:37:00 +08:00			`table`
New feature: environment plus documentation about the environment table and its usage with scripts. 2017-04-03 04:10:00 +08:00			`userdata`
			`environment`
this_environment is now live 2017-05-10 01:24:56 +08:00			`this_environment`
balance that stack, goddamnit, BALANCE IT 2016-09-20 11:37:00 +08:00			`proxy`
[ci skip] tfw you forget to add it to the table of contents 2016-11-05 07:44:51 +08:00			`containers`
[ci-skip] docs 2017-03-31 02:14:31 +08:00			`nested`
balance that stack, goddamnit, BALANCE IT 2016-09-20 11:37:00 +08:00			`as_table`
			`usertype`
			`simple_usertype`
			`usertype_memory`
			`unique_usertype_traits`
			`tie`
The docs are here. 2016-03-12 06:47:15 +08:00			`function`
			`protected_function`
balance that stack, goddamnit, BALANCE IT 2016-09-20 11:37:00 +08:00			`coroutine`
			`error`
The docs are here. 2016-03-12 06:47:15 +08:00			`object`
balance that stack, goddamnit, BALANCE IT 2016-09-20 11:37:00 +08:00			`thread`
			`optional`
			`variadic_args`
[ci skip] as_args docs 2016-11-27 03:04:44 +08:00			`as_args`
The docs are here. 2016-03-12 06:47:15 +08:00			`overload`
balance that stack, goddamnit, BALANCE IT 2016-09-20 11:37:00 +08:00			`property`
			`var`
protect could use some additional optimizations for space, but I'm kinna tired. 2016-07-09 15:43:51 +08:00			`protect`
			`readonly`
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			`as_function`
balance that stack, goddamnit, BALANCE IT 2016-09-20 11:37:00 +08:00			`c_call`
			`resolve`
The docs are here. 2016-03-12 06:47:15 +08:00			`stack`
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`
balance that stack, goddamnit, BALANCE IT 2016-09-20 11:37:00 +08:00			`compatibility`
			`types`
			`metatable_key`
new travis environments to be tested out for osx stuff, plus new_table docs and environments on function calls 2017-04-03 10:37:01 +08:00			`new_table`