Difference between revisions of "Setfenv"

From GiderosMobile
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
+
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
'''Class:''' [[(global)]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/(global)|(global)]]<br/>
 
  
=== <translate>Description</translate> ===
+
=== Description ===
<translate>Sets the environment to be used by the given function. f can be a Lua function or a number that specifies the function at that stack level: Level 1 is the function calling setfenv. setfenv returns the given function.
+
Sets the environment to be used by the given function.
 
 
As a special case, when f is 0 setfenv changes the environment of the running thread. In this case, setfenv returns no values.</translate>
 
 
<source lang="lua">
 
<source lang="lua">
 
(varies) = setfenv(f,table)
 
(varies) = setfenv(f,table)
 
</source>
 
</source>
  
=== <translate>Parameters</translate> ===
+
''f'' can be a Lua function or a number that specifies the function at that stack level: Level 1 is the function calling ''setfenv''. ''setfenv'' returns the given function.
'''f''': (varies) <translate>function or number(call stack level)</translate> <br/>
+
 
'''table''': (table) <translate>environment table to set</translate> <br/>
+
As a special case, when f is 0 ''setfenv'' changes the environment of the running thread. In this case, ''setfenv'' returns no values.
 +
 
 +
=== Parameters ===
 +
'''f''': (varies) function or number(call stack level)<br/>
 +
'''table''': (table) environment table to set<br/>
  
=== <translate>Return values</translate> ===
+
=== Return values ===
'''<translate>Returns</translate>''' (varies) <translate>returns provided function or nil</translate><br/>
+
'''Returns''' (varies) returns provided function or nil<br/>
  
 
{{(global)}}
 
{{(global)}}

Revision as of 22:26, 13 May 2022

Available since: Gideros 2011.6
Class: (global)

Description

Sets the environment to be used by the given function.

(varies) = setfenv(f,table)

f can be a Lua function or a number that specifies the function at that stack level: Level 1 is the function calling setfenv. setfenv returns the given function.

As a special case, when f is 0 setfenv changes the environment of the running thread. In this case, setfenv returns no values.

Parameters

f: (varies) function or number(call stack level)
table: (table) environment table to set

Return values

Returns (varies) returns provided function or nil