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

Fix safety.rst typo

Browse Source 
The documentation states SOL_SAFE_FUNCTION, but in code its called SOL_SAFE_FUNCTION(S)
This commit is contained in:
Marcus Tillmanns 2024-01-15 10:06:51 +01:00 committed by GitHub
parent e8e122e9ce
commit 27fdff9eca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/source/safety.rst
View File

@ -30,7 +30,7 @@ Safety Config
* All calls from Lua will have their arguments checked * All calls from Lua will have their arguments checked
* Turned on by default with clang++, g++ and VC++ if a basic check for building in debug mode is detected (lack of ``_NDEBUG`` or similar compiler-specific checks) * Turned on by default with clang++, g++ and VC++ if a basic check for building in debug mode is detected (lack of ``_NDEBUG`` or similar compiler-specific checks)
``SOL_SAFE_FUNCTION`` triggers the following change: ``SOL_SAFE_FUNCTIONS`` triggers the following change:
* All uses of ``sol::function`` and ``sol::stack_function`` will default to ``sol::protected_function`` and ``sol::stack_protected_function``, respectively, rather than ``sol::unsafe_function`` and ``sol::stack_unsafe_function`` * All uses of ``sol::function`` and ``sol::stack_function`` will default to ``sol::protected_function`` and ``sol::stack_protected_function``, respectively, rather than ``sol::unsafe_function`` and ``sol::stack_unsafe_function``
- Note this does not apply to ``sol::stack_aligned_function``: this variant must always be unprotected due to stack positioning requirements, especially in use with ``sol::stack_count`` - Note this does not apply to ``sol::stack_aligned_function``: this variant must always be unprotected due to stack positioning requirements, especially in use with ``sol::stack_count``
* Will make any ``sol::state_view::script`` calls default to their safe variants if there is no supplied environment or error handler function * Will make any ``sol::state_view::script`` calls default to their safe variants if there is no supplied environment or error handler function