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] doc fixes

Browse Source
This commit is contained in:
ThePhD 2017-09-06 15:13:17 -04:00
parent fb276676d1
commit fbdc5d9798
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -107,6 +107,7 @@ enumerations
new_index,
mode,
call,
call_function = call,
metatable,
to_string,
length,
@ -123,14 +124,24 @@ enumerations
less_than,
less_than_or_equal_to,
garbage_collect,
call_function = call,
pairs
floor_division,
bitwise_left_shift,
bitwise_right_shift,
bitwise_not,
bitwise_and,
bitwise_or,
bitwise_xor,
pairs,
ipairs,
next,
type,
type_info,
};
typedef meta_function meta_method;
Use this enumeration to specify names in a manner friendlier than memorizing the special lua metamethod names for each of these. Each binds to a specific operation indicated by the descriptive name of the enum. You can read more about `the metamethods in the Lua manual`_ and learn about how they work and are supposed to be implemented there. Each of the names here (except for the ones used as shortcuts to other names like ``meta_function::call_function`` and ``meta_function::involution`` and not including ``construct``, which just maps to the name ``new``) link directly to the Lua name for the operation. ``meta_function::pairs`` is only available in Lua 5.2 and above (does not include LuaJIT or Lua 5.1).
Use this enumeration to specify names in a manner friendlier than memorizing the special lua metamethod names for each of these. Each binds to a specific operation indicated by the descriptive name of the enum. You can read more about `the metamethods in the Lua manual`_ and learn about how they work and are supposed to be implemented there. Each of the names here (except for the ones used as shortcuts to other names like ``meta_function::call_function`` and ``meta_function::involution`` and not including ``construct``, which just maps to the name ``new``) link directly to the Lua name for the operation. ``meta_function::pairs`` is only available in Lua 5.2 and above (does not include LuaJIT or Lua 5.1) and ``meta_function::ipairs`` is only available in Lua 5.2 exactly (disregarding compatibiltiy flags).
members
-------