Difference between revisions of "Setfenv"

From GiderosMobile
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
 
'''Class:''' [[(global)]]<br/>
 
'''Class:''' [[(global)]]<br/>
  
'''This function is deprecated'''
 
 
=== Description ===
 
=== Description ===
 
Sets the environment to be used by the given function.
 
Sets the environment to be used by the given function.
Line 31: Line 30:
  
 
=== See also ===
 
=== See also ===
'''https://www.lua.org/pil/14.3.html'''
+
'''https://luau.org/library#global-functions'''<br/>
 +
'''https://www.lua.org/pil/14.3.html'''<br/>
 +
'''[[setsafeenv]]'''
  
 
{{(global)}}
 
{{(global)}}

Latest revision as of 12:08, 21 July 2025

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

Example

a = 1   -- create a global variable
-- change current environment
setfenv(1, {_G = _G})
_G.print(a)      --> nil
_G.print(_G.a)   --> 1

See also

https://luau.org/library#global-functions
https://www.lua.org/pil/14.3.html
setsafeenv