Codectionary / Developer documentation / Lua

Lua __index metamethod

Lua reference for lua __index metamethod.

Syntax

local defaults = { active = true }
setmetatable(user, { __index = defaults })

Examples

Lua __index metamethod example

A focused example you can adapt while practising.

local defaults = { active = true }
setmetatable(user, { __index = defaults })

Best practices

  • Start with the smallest working example, then adapt it to your project.
  • Use the language’s standard library and idioms before introducing extra dependencies.

At a glance

Purpose
Lightweight scripting and embedding
File extension
.lua
Runs in
Lua interpreter or a host application
Usually used with
Host APIs and Lua modules

Specifications & further reading

Related Lua documentation