La métaméthode __newindex

Vous avez appris comment __index contrôle ce qui se passe lorsque vous essayez de lire une clé qui n'existe pas dans une table. Maintenant, vous allez découvrir son homologue : __newindex, qui contrôle ce qui se passe lorsque vous essayez d'ajouter ou de modifier une paire clé-valeur.

La métaméthode __newindex est déclenchée chaque fois que vous tentez d'assigner une valeur à une clé qui n'existe pas actuellement dans la table. Cela vous donne le pouvoir d'intercepter et de contrôler les modifications avant qu'elles ne se produisent.

Voici un exemple simple qui empêche l'ajout de nouvelles clés à une table :

local readOnly = {}
local meta = {
    __newindex = function(table, key, value)
        print("Cannot add key: " .. key)
    end
}

setmetatable(readOnly, meta)

readOnly.name = "Alice"  -- Sortie : Cannot add key: name
print(readOnly.name)     -- Sortie : nil

Lorsque vous essayez de définir readOnly.name = "Alice", Lua voit que name n'existe pas dans la table. Au lieu de l'ajouter, Lua appelle la fonction __newindex avec trois arguments : la table elle-même, la clé en cours de définition et la valeur en cours d'assignation.

Dans cet exemple, la fonction affiche simplement un message et ne stocke rien en réalité.

Vous pouvez également utiliser __newindex pour valider les données avant de les autoriser dans votre table :

local player = {}
local meta = {
    __newindex = function(t, key, value)
        if key == "health" and type(value) ~= "number" then
            print("Health must be a number!")
        else
            rawset(t, key, value)
        end
    end
}

setmetatable(player, meta)

player.health = "high"  -- Sortie : Health must be a number!
player.health = 100     -- Autorisé

Remarquez l'utilisation de rawset() dans le second exemple. Cette fonction contourne la métatable et définit directement la valeur dans la table.

Sans cela, définir la valeur déclencherait à nouveau __newindex, créant une boucle infinie.