An issue with getfenv()

[ExercitusMortem (Exercitus)]

Here’s the code Roblox provides.

-- Get the environment based on stack

local function whatIsThePassword(password)
    local env = getfenv(1)  -- Get the environment 1 level up, or whatever called this function
    print(env.password)  -- Get the password from the environment one level up
    print(password)  --> nil
end

local function openSesame()
    local password = "secret"  -- A variable local to openSesame()
    whatIsThePassword(password)
end

openSesame()

So, running this, the expected output would be

-- secret
-- nil

However, the actual output:

-- nil
-- secret

Anyone knows why? Tested in studio and in test.

[index_self]

The documentation is wrong. password in openSesame is local and won’t be in env.password, so the results are flopped.

Missing information for documentation of lots of globals

Another thing, under getfenv there is an example of getting the enviroment based on the stack, but a local is used and the stack index is wrong. A better example would be function whatIsThePassword() local env = getfenv(2) -- Get the environment 1 level up, or whatever called this function print(env.password) -- Get the password from the environment one level up print(password) --> nil end function openSesame() password = "secret" -- A variable local to openSesame since enviroment was set …