元表事件

wiki

• __index - 控制“原型”继承。当访问“myTable[key]”并且该键不在表中，但元表具有 __index 属性时
  • 如果该值为函数，则调用该函数，传入表和键；该函数的返回值作为结果返回。
  • 如果该值为另一个表，则请求并返回该表中键的值
    • （如果该键在该表中不存在，但该表的元表具有 __index 属性，则继续向上查找）
  • 使用“rawget(myTable,key)”跳过此元方法。

• __newindex - 控制属性赋值。当调用“myTable[key] = value”时，如果元表具有指向函数的 __newindex 键，则调用该函数，传入表、键和值。
  • 使用“rawset(myTable,key,value)”跳过此元方法。
  • （如果 __newindex 函数没有在表上设置键（使用 rawset），则不会将键值对添加到 myTable 中。）

• __mode - 控制弱引用。一个字符串值，包含一个或两个字符 'k' 和 'v'，指定表中的key 和/或value 是弱引用。

• __call - 将表视为函数。当表后面跟着括号，例如“myTable( 'foo' )”，并且元表具有指向函数的 __call 键时，将调用该函数（将表作为第一个参数传入，后面跟着任何指定的参数），并返回返回值。

• __metatable - 隐藏元表。当调用“getmetatable( myTable )”时，如果 myTable 的元表具有 __metatable 键，则返回该键的值，而不是实际的元表。

• __tostring - 控制字符串表示。当调用内置函数 "tostring( myTable )" 时，如果 myTable 的元表中有一个 __tostring 属性设置为函数，则该函数将被调用（将 myTable 传递给它），返回值将用作字符串表示。

• __len - (Lua 5.2+) 控制报告的表长度。当使用长度运算符（'#'）请求表长度时，如果 myTable 的元表中有一个 __len 键指向函数，则该函数将被调用（将 myTable 传递给它），返回值用作 "#myTable" 的值。

• __pairs - (Lua 5.2+) 处理遍历表对，当调用 for k,v in pairs(tbl) do ... end 时（参见 GeneralizedPairsAndIpairs）。

• __ipairs - (Lua 5.2+) 处理遍历表对，当调用 for k,v in ipairs(tbl) do ... end 时（参见 GeneralizedPairsAndIpairs）。

• __gc - 用户数据终结器代码。当用户数据被设置为垃圾回收时，如果元表中有一个 __gc 字段指向函数，则该函数将首先被调用，并将用户数据传递给它。__gc 元方法不会为表调用。（参见 https://lua-users.lua.ac.cn/lists/lua-l/2006-11/msg00508.html）

• __name - 当它包含一个字符串时，可以被 tostring 和错误消息使用。

• __close - (Lua 5.4+) 使元表成为要关闭的变量，如果未设置为 nil 或 false。

数学运算符

• __unm - 一元减号。当编写 "-myTable" 时，如果元表中有一个 __unm 键指向函数，则该函数将被调用（传递表），返回值用作 "-myTable" 的值。
• __add - 加法。当编写 "myTable + object" 或 "object + myTable" 时，如果 myTable 的元表中有一个 __add 键指向函数，则该函数将被调用（按顺序传递左右操作数），返回值将被使用。
  • ''如果两个操作数都是表，则在检查右表之前检查左表是否存在 __add 元事件。

• __sub - 减法。类似于加法调用，使用 '-' 运算符。
• __mul - 乘法。类似于加法调用，使用 '*' 运算符。
• __div - 除法。类似于加法调用，使用 '/' 运算符。
• __idiv - (Lua 5.3) 地板除法（向下舍入到最接近整数的除法）。'//' 运算符。
• __mod - 模运算。类似于加法调用，使用 '%' 运算符。
• __pow - 幂运算。类似于加法，使用 '^' 运算符调用。
• __concat - 连接。类似于加法，使用 '..' 运算符调用。

位运算符

Lua 5.3 引入了使用真整数的能力，以及位运算。这些运算类似于加法运算，但如果任何操作数既不是整数也不是可以强制转换为整数的值，Lua 将尝试元方法。

• __band - (Lua 5.3) 按位与 (&) 运算。
• __bor - (Lua 5.3) 按位或 (|) 运算。
• __bxor - (Lua 5.3) 按位异或 (二进制 ^) 运算。
• __bnot - (Lua 5.3) 按位取反 (一元 ~) 运算。
• __shl - (Lua 5.3) 按位左移 (<<) 运算。
• __shr - (Lua 5.3) 按位右移 (>>) 运算。

等价比较运算符

• __eq - 检查相等。当 "myTable1 == myTable2" 被评估时调用此方法，但前提是两个表都具有完全相同的 __eq 元方法。
  • 例如，请参见以下代码

  t1a = {}
  t1b = {}
  t2  = {}
  mt1 = { __eq = function( o1, o2 ) return 'whee' end }
  mt2 = { __eq = function( o1, o2 ) return 'whee' end }
  
  setmetatable( t1a, mt1 )
  setmetatable( t1b, mt1 )
  setmetatable( t2,  mt2 )
  
  print( t1a == t1b )     --> true
  print( t1a == t2 )      --> false
  

  • 如果函数返回 nil 或 false，则比较结果为 false；否则，结果为 true。

• 如果 t1 和 t2 引用的是同一个表，则不会为 t1 == t2 调用 __eq 方法。

function foo (o1, o2) 
  print( '__eq call' )
  return false 
end

t1 = {}
setmetatable( t1, {__eq = foo} )

t2 = t1
print( t1 == t2 ) --> true
        -- string '__eq call' not printed (and comparison result is true, not like the return value of foo(...)), so no foo(...) call here

t3 = {}
setmetatable( t3, {__eq = foo} )
if t1 == t3 then end  --> __eq call
        -- foo(...) was called

• __lt - 检查小于。类似于相等，使用 '<' 运算符。
  • 大于通过反转传递给 __lt 函数的操作数顺序来评估。

  a > b == b < a
  

• __le - 检查小于或等于。类似于相等，使用 '<=' 运算符。
  • 大于或等于通过反转传递给 __le 函数的操作数顺序来评估。

  a >= b == b <= a