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

Note requirements in documentation about pairs generation.

Browse Source
This commit is contained in:
ThePhD 2020-02-16 19:44:11 +01:00
parent bc96c1d7b2
commit f1ad1de70a
No known key found for this signature in database
GPG Key ID: 1509DB1C0F702BFA
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/api/usertype.rst
View File

@ -189,8 +189,9 @@ If you don't specify a ``sol::meta_function`` name (or equivalent string metamet
- a ``sol::meta_function::call`` operator will be generated
- the function call operator in C++ must not be overloaded, otherwise sol will be unable to bind it automagically
- the function call operator in C++ must not be templated, otherwise sol will be unable to bind it automagically
- if it is overloaded or templated, it is your reponsibility to bind it properly
* for automatic iteration where ``begin()`` and ``end()`` exist on the C++ type
- if it is overloaded or templated, it is your responsibility to bind it properly
* for automatic iteration where ``begin()`` and ``end()`` functions exist on the C++ type
- the type **must** have a ``value_type``, ``iterator``, and `similar Container typedefs`_.
- a ``sol::meta_function::pairs`` operator is generated for you
- Allows you to iterate using ``for k, v in pairs( obj ) do ... end`` in Lua
- **Lua 5.2 and better only: LuaJIT does not allow this, Lua 5.1 does NOT allow this**
@ -330,3 +331,4 @@ performance note
.. _small starter example here: https://github.com/ThePhD/sol2/blob/develop/examples/source/usertype_basics.cpp
.. _runtime extensible: https://github.com/ThePhD/sol2/blob/develop/examples/source/usertype_advanced.cpp#L81
.. _the metamethods in the Lua manual: https://www.lua.org/manual/5.3/manual.html#2.4
.. _similar Container typedefs: http://eel.is/c++draft/container.requirements.general#4