debug.getstack - Potassium

function debug.getstack(level: number, index: number?): ( any | { any } )

number

required

The stack level at which the objects are collected.

number

The index of a specific object on the stack to return. If omitted, the entire stack at the given level is returned as a table.

Alias: getstack

Example debug.getstack returning a table.

This code sample will print all of the objects on the calling function’s stack.

-- Imagine this is a hook of some kind.
function foo(vec3)
    local stack = debug.getstack(2)
    for i, v in stack do
        print(i, v)
    end
end

local function bar()
    local vec3 = Vector3.new()

    foo(vec3)

    return vec3
end

bar()

Example debug.getstack returning a singluar object.

This code sample will print a single object that’s on the calling function’s stack.

-- Imagine this is a hook of some kind.
function foo(vec3)
    local object = debug.getstack(2, 3)
    print(object)
end

local function bar()
    local vec3 = Vector3.new()

    foo(vec3)

    return vec3
end

bar()

​Example debug.getstack returning a table.

​Example debug.getstack returning a singluar object.

Example debug.getstack returning a table.

Example debug.getstack returning a singluar object.