Metatable 事件

wiki

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

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

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

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

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

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

• __len - (Lua 5.2+) 控制报告的表长度。当使用长度运算符（ '#' ）请求表长度时，如果 myTable 的 metatable 有一个指向函数的 __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 - 用户数据终结器代码。当用户数据被设置为垃圾回收时，如果 metatable 有一个指向函数的 __gc 字段，则首先调用该函数，将用户数据传递给它。__gc 元方法不用于表。（参见 https://lua-users.lua.ac.cn/lists/lua-l/2006-11/msg00508.html）

• __name - 当包含字符串时，可用于 tostring 和错误消息。

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

数学运算符

• __unm - 一元减法。当编写“-myTable”时，如果 metatable 有一个指向函数的 __unm 键，则调用该函数（传入表），并使用其返回值作为“-myTable”的值。
• __add - 加法。当编写“myTable + object”或“object + myTable”时，如果 myTable 的 metatable 有一个指向函数的 __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