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] state doc updates

Browse Source
This commit is contained in:
ThePhD 2017-04-03 00:08:56 -04:00
parent 263b492afa
commit 07cee03a8b
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/api/state.rst
View File

@ -56,12 +56,18 @@ This function takes a number of :ref:`sol::lib<lib-enum>` as arguments and opens
:name: state-script-function :name: state-script-function
sol::function_result script(const std::string& code); sol::function_result script(const std::string& code);
sol::function_result script_file(const std::string& filename); sol::protected_function_result script(const std::string& code, const environment& env);
template <typename Func> template <typename Func>
sol::protected_function_result script(const std::string& code, Func&& func); sol::protected_function_result script(const std::string& code, Func&& func);
template <typename Func> template <typename Func>
sol::protected_function_result script(const std::string& code, const environment& env, Func&& func);
sol::function_result script_file(const std::string& filename);
sol::protected_function_result script_file(const std::string& filename, const environment& env);
template <typename Func>
sol::protected_function_result script_file(const std::string& filename, Func&& func); sol::protected_function_result script_file(const std::string& filename, Func&& func);
template <typename Func>
sol::protected_function_result script_file(const std::string& filename, const environment& env, Func&& func);
These functions run the desired blob of either code that is in a string, or code that comes from a filename, on the ``lua_State*``. It will not run isolated: any scripts or code run will affect code in the ``lua_State*`` the object uses as well (unless ``local`` is applied to a variable declaration, as specified by the Lua language). Code ran in this fashion is not isolated. If you need isolation, consider creating a new state or traditional Lua sandboxing techniques. These functions run the desired blob of either code that is in a string, or code that comes from a filename, on the ``lua_State*``. It will not run isolated: any scripts or code run will affect code in the ``lua_State*`` the object uses as well (unless ``local`` is applied to a variable declaration, as specified by the Lua language). Code ran in this fashion is not isolated. If you need isolation, consider creating a new state or traditional Lua sandboxing techniques.