getmetafield

Returns a raw metafield value from the target metatable. target may be any value, and field must be a string. The function does not call the metafield, does not invoke __index lookup, and returns nil when the metatable or field is missing.

Syntax

getmetafield(target: any, field: string): any | nil

Arguments

Name	Type	Required	Description
`target`	`any`	Yes	Value whose metatable is inspected.
`field`	`string`	Yes	Metafield name to read.

Returns

Name	Type	Description
`fieldValue`	`any \| nil`	Raw metafield value when present; otherwise nil.

Example

Read one raw metafield value from a value’s metatable.

local target = {}
local meta = {
    __index = function()
        return "fallback"
    end,
}

setrawmetatable(target, meta)

local field = getmetafield(target, "__index")
print(type(field))
print(getmetafield(target, "__newindex"))

⌘I

Overview

Cache

Cryptography

Filesystem

JSON

Console

Drawing

ImGui

Input

Instances

Reflection

Scripts

Signals

WebSocket

Actors

Closures

Debug

Environment

Metatables

Threads

Disassembler

Miscellaneous

RakNet

RealSignal

SaveInstance

Syntax

Arguments

Returns

Example

​Syntax

​Arguments

​Returns

​Example

Syntax

Arguments

Returns

Example