Difference between revisions of "Getfenv"

From GiderosMobile
 
(2 intermediate revisions by one other user not shown)
Line 5: Line 5:
 
=== Description ===
 
=== Description ===
 
Returns the current environment in use by the function.
 
Returns the current environment in use by the function.
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
(table) = getfenv(f)
 
(table) = getfenv(f)
</source>
+
</syntaxhighlight>
  
 
''f'' can be a Lua function or a number that specifies the function at that stack level: Level 1 is the function calling getfenv. If the given function is not a Lua function, or if f is 0, getfenv returns the global environment. The default for f is 1.
 
''f'' can be a Lua function or a number that specifies the function at that stack level: Level 1 is the function calling getfenv. If the given function is not a Lua function, or if f is 0, getfenv returns the global environment. The default for f is 1.
Line 16: Line 16:
 
=== Return values ===
 
=== Return values ===
 
'''Returns''' (table) environment with all the defined values in environment scope<br/>
 
'''Returns''' (table) environment with all the defined values in environment scope<br/>
 +
 +
=== See also ===
 +
'''https://luau.org/library#global-functions'''<br/>
  
 
{{(global)}}
 
{{(global)}}

Latest revision as of 12:19, 21 July 2025

Available since: Gideros 2011.6
Class: (global)

Description

Returns the current environment in use by the function.

(table) = getfenv(f)

f can be a Lua function or a number that specifies the function at that stack level: Level 1 is the function calling getfenv. If the given function is not a Lua function, or if f is 0, getfenv returns the global environment. The default for f is 1.

Parameters

f: (varies) function or number(call stack level) optional

Return values

Returns (table) environment with all the defined values in environment scope

See also

https://luau.org/library#global-functions