StarMirror/sol2
1
0
Fork 0
mirror of https://github.com/ThePhD/sol2.git synced 2024-03-22 13:10:44 +08:00
Code Issues Projects Releases Wiki Activity

[ci skip] almost left something out of the docs

Browse Source
This commit is contained in:
ThePhD 2017-04-02 22:47:02 -04:00
parent 7fa7f0f2e9
commit 1f98a86a27
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/api/environment.rst
View File

@ -9,7 +9,7 @@ encapsulation table for script sandboxing
class environment : public table;
template <typename T>
void set_environment( const T& target, const environment& env);
void set_environment( const environment& env, const T& target );
This type is passed to :ref:`sol::state(_view)::script/do_x<state-script-function>` to provide an environment where local variables that are set and get retrieve. It is just a plain table, and all the same operations :doc:`from table still apply<table>`. This is important because it allows you to do things like set the table's metatable (using :doc:`sol::metatable_key<metatable_key>` for instance) and having its ``__index`` entry point to the global table, meaning you can get -- but not set -- variables from a Global environment.
@ -23,6 +23,14 @@ You can set the environment using ``sol::set_environment( some_reference, my_env
free functions
--------------
.. code-block:: cpp
:caption: function: set_environment
template <typename T>
void set_environment( const environment& env, const T& target );
See :ref:`environment::set_on<environment-set-on>`.
members
-------
@ -37,7 +45,7 @@ The ones from table are used here (of particular note is the ability to use ``so
.. code-block:: cpp
:caption: function: set_on
:name: environment-set-on
template <typename T>
void set_on(const T& target);