Difference between revisions of "Getfenv"
From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>") |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | ''' | + | '''Available since:''' Gideros 2011.6<br/> |
| − | === | + | '''Class:''' [[(global)]]<br/> |
| − | + | ||
| − | < | + | === Description === |
| + | Returns the current environment in use by the function. | ||
| + | <syntaxhighlight lang="lua"> | ||
(table) = getfenv(f) | (table) = getfenv(f) | ||
| − | </ | + | </syntaxhighlight> |
| − | === | + | |
| − | '''f''': (varies) | + | ''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/> | ||
| + | |||
| + | {{(global)}} | ||
Latest revision as of 15: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
