sol2/docs/source/api/new_table.rst

new_table
=========
*a table creation hint to environment/table*


.. code-block:: cpp
	
	struct new_table;

	constexpr const new_table create = new_table{};

``sol::new_table`` serves the purpose of letting you create tables using the constructor of :doc:`sol::table<table>` and :doc:`sol::environment<environment>`. It also disambiguates the other kinds of constructors, so is **necessary** to be specified. Leaving it off will result in the wrong constructor to be called, for either ``sol::table`` or ``sol::environment``.

members
-------

.. code-block:: cpp
	:caption: constructor: new_table

	new_table(int sequence_hint = 0, int map_hint = 0);
	
The constructor's sole purpose is to either let you default-constructor the type, in which case it uses the values of "0" for its two hints, or letting you specify either ``sequence_hint`` or both the ``sequence_hint`` and ``map_hint``. Each hint is a heuristic helper for Lua to allocate an appropriately sized and structured table for what you intend to do. In 99% of cases, you will most likely not care about it and thusly will just use the constant ``sol::create`` as the second argument to object-creators like ``sol::table``'s constructor.
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`
			`=========`
this mega commit prepares to fix all of the issues listed in the repository for the past 3 weeks 2017-08-06 07:20:28 +08:00			`a table creation hint to environment/table`

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
			`.. code-block:: cpp`

			`struct new_table;`

prepare for new usertype change how type T is gleaned from destructors and constructors in case of new syntax add a hell of a lot more examples, update and clean documentation 2018-03-16 05:16:28 +08:00			`constexpr const new_table create = new_table{};`
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
			``sol::new_table`` serves the purpose of letting you create tables using the constructor of :doc:`sol::table<table>` and :doc:`sol::environment<environment>`. It also disambiguates the other kinds of constructors, so is necessary to be specified. Leaving it off will result in the wrong constructor to be called, for either ``sol::table`` or ``sol::environment``.

			`members`
			`-------`

			`.. code-block:: cpp`
			`:caption: constructor: new_table`

			`new_table(int sequence_hint = 0, int map_hint = 0);`

			The constructor's sole purpose is to either let you default-constructor the type, in which case it uses the values of "0" for its two hints, or letting you specify either ``sequence_hint`` or both the ``sequence_hint`` and ``map_hint``. Each hint is a heuristic helper for Lua to allocate an appropriately sized and structured table for what you intend to do. In 99% of cases, you will most likely not care about it and thusly will just use the constant ``sol::create`` as the second argument to object-creators like ``sol::table``'s constructor.