元表的事件

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 - Userdata 最終化器程式碼，如果 userdata 被設為要進行垃圾收集，如果 metatable 有個指向函式的 __gc 欄位，會先呼叫該函數，並傳遞 userdata 給它。__gc metamethod 並不會在表格上呼叫。（見 https://lua-users.dev.org.tw/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 metaevent。

• __sub - 減法。呼叫方式類似於加法，使用 '-' 運算子。
• __mul - 乘法。呼叫方式類似於加法，使用 '*' 運算子。
• __div - 除法。呼叫方式類似於加法，使用 '/' 運算子。
• __idiv - (Lua 5.3) 取整除法（向下取整除法）。'//' 運算子。
• __mod - 取餘數。呼叫方式類似於加法，使用 '%' 運算子。
• __pow - 冪。呼叫方式類似於加法，使用 '^' 運算子。
• __concat - 串接。呼叫方式類似於加法，使用 '..' 運算子。

位元運算子

Lua 5.3 引入了使用正確整數的功能，並具備位元運算。執行這些運算的方式類似於加法運算，但如果任何運算元都不是整數或無法轉換為整數的值，Lua 會嘗試 metamethod。

• __band - (Lua 5.3) 位元 AND (&) 運算。
• __bor - (Lua 5.3) 位元 OR (|) 運算。
• __bxor - (Lua 5.3) 位元異或 (binary ^) 運算。
• __bnot - (Lua 5.3) 位元 NOT (一元 ~) 運算。
• __shl - (Lua 5.3) 位元左移 (<<) 運算。
• __shr - (Lua 5.3) 位元右移 (>>) 運算。

等值比較運算子

• __eq - 檢查等值。這個方法是在評估 "myTable1 == myTable2" 時呼叫，但僅在兩個表格針對 __eq 有完全相同的 metamethod 時才會呼叫。
  • 舉例來說，請看以下程式碼

  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