Metametoda __newindex

Dowiedziałeś się, jak __index kontroluje to, co się dzieje, gdy próbujesz odczytać klucz, który nie istnieje w tablicy. Teraz poznasz jego odpowiednik: __newindex, który kontroluje to, co się dzieje, gdy przypisujesz wartość do klucza, którego tablica jeszcze nie zawiera.

Metametoda __newindex jest wywoływana za każdym razem, gdy próbujesz przypisać wartość do klucza, który obecnie nie istnieje w tabeli. Dzięki temu możesz przechwytywać i kontrolować modyfikacje, zanim do nich dojdzie.

Oto prosty przykład, który uniemożliwia dodawanie nowych kluczy do tabeli:

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

setmetatable(readOnly, meta)

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

Gdy próbujesz ustawić readOnly.name = "Alice", Lua widzi, że klucz name nie istnieje w tabeli. Zamiast go dodać, Lua wywołuje funkcję __newindex z trzema argumentami: samą tabelą, ustawianym kluczem i przypisywaną wartością.

W tym przykładzie funkcja po prostu wyświetla komunikat i tak naprawdę niczego nie przechowuje.

Możesz też użyć __newindex, aby zweryfikować dane przed dodaniem ich do swojej tablicy:

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"  -- Wynik: Health must be a number!
player.health = 100     -- Dozwolone, zapisane za pomocą rawset
player.health = "high"  -- Brak komunikatu: health już istnieje

Zwróć uwagę na użycie rawset() w drugim przykładzie. Ta funkcja omija metatabelę i bezpośrednio ustawia wartość w tabeli.

Bez tego ustawienie wartości ponownie wywołałoby __newindex, tworząc nieskończoną pętlę.

Ponieważ __newindex uruchamia się tylko dla kluczy, których tabela nie zawiera, to sprawdzenie zabezpiecza pierwsze przypisanie każdego klucza. Gdy rawset zapisze już health, kolejne przypisania zmieniają tę wartość bezpośrednio. Aby sprawdzać każde przypisanie, pozostaw samą tabelę pustą i przechowuj wartości w drugiej tabeli, do której odwołuje się ona przez __index:

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

player.health = 100
player.health = "high"  -- Wynik: Health must be a number!
print(player.health)    -- Wynik: 100

player nigdy nie otrzymuje własnego klucza, więc każde przypisanie przechodzi przez __newindex, a każdy odczyt przechodzi przez __index do data.