Difference between revisions of "Getfenv"

From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' Gideros 2011.6<br/> === Description === Returns the current environment in use by the function. f can be a Lua function or a number that speci...")
 
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[(global)]]<br/>
 +
 
=== Description ===
 
=== Description ===
Returns the current environment in use by the function. 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.
+
Returns the current environment in use by the function.
<source lang="lua">
+
<syntaxhighlight lang="lua">
(table), = getfenv(f,)
+
(table) = getfenv(f)
</source>
+
</syntaxhighlight>
'''f:''' (varies) function or number(call stack level) '''optional'''<br/>
+
 
 +
''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'''<br/>
 +
 
 +
=== 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/>
 +
 +
{{(global)}}

Latest revision as of 14:29, 13 July 2023

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