From 07ca82f96867db303e7d1c337f1d5538a776c938 Mon Sep 17 00:00:00 2001 From: cpunch Date: Wed, 24 Feb 2021 12:52:31 -0600 Subject: [PATCH] Added '__equal' metamethod docs --- docs/objects.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/objects.md b/docs/objects.md index d830152..b7393be 100644 --- a/docs/objects.md +++ b/docs/objects.md @@ -94,11 +94,12 @@ that are called on special operators. | __init | `(, ...)` | Newly crafted object is passed, called on instantiation | | __newindex | `(, key, newValue)` | Called on new index using the '[] = ' operator | | __index | `(, key)` -> `value` | Called on index using the '[]' operator | +| __equal | `(, )` -> `` | Called on equality fail if both protos have the same `__equal` metamethod defined | | __tostring | `()` -> `` | Called when tostring() is called on an object | | __tonumber | `()` -> `` | Called when tonumber() is called on an object | | __count | `()` -> `` | Called when object is used with the '#' count operator | | __iter | `()` -> `` | Called when used in a for-each loop with the 'in' operator | -| __next | `()` -> `...` | Called on each iteration in a for-each loop, return values are passed as parameters in the loop | +| __next | `()` -> `...` | Called on each iteration in a for-each loop, return values are passed as parameters in the loop | | __getter | `[ fieldName : getterMethod]` | Indexed & called on field get using the '.' operator | | __setter | `[ fieldName : setterMethod]` | Indexed & Called on field set using the '.' & '=' operators | > -> means 'returns' \ No newline at end of file