debug

Returns a traceback of the current function call stack as a string; in other words, a description of the functions that have been called up to this point. During debugging, this behaves like an error stack trace but does not stop execution of the script.

The level parameter specifies what level of the call stack to consider, with 1 being the call of debug.traceback() itself, 2 being the call of the function calling debug.traceback(), and so on. See the code sample below for an example of sequential function calls.

Note that this function will often return inaccurate results (compared to the original source code) and that the format of the returned traceback may change at any time. You should not parse the return value for specific information such as script names or line numbers.

The following example includes sequential function calls; fnB() is called, and it calls fnA() which then calls debug.traceback().

local function fnA()
	print(debug.traceback("Specific moment during fnA()"))
end

local function fnB()
	fnA()
end

-- Call function fnB() to begin traceback
fnB()

Returns a traceback of the current function call stack as a string; in other words, a description of the functions that have been called up to this point. During debugging, this behaves like an error stack trace but does not stop execution of the script.

The level parameter specifies what level of the call stack to consider, with 1 being the call of debug.traceback() itself, 2 being the call of the function calling debug.traceback(), and so on. See the code sample below for an example of sequential function calls.

Note that this function will often return inaccurate results (compared to the original source code) and that the format of the returned traceback may change at any time. You should not parse the return value for specific information such as script names or line numbers.

The following example includes sequential function calls; fnB() is called, and it calls fnA() which then calls debug.traceback().

local function fnA()
	print(debug.traceback("Specific moment during fnA()"))
end

local function fnB()
	fnA()
end

-- Call function fnB() to begin traceback
fnB()

Allows programmatic inspection of the call stack. This function differs from debug.traceback() in that it guarantees the format of the data it returns. This is useful for general logging and filtering purposes as well as for sending the data to systems expecting structured input, such as crash aggregation.

local function fnA()
	-- Output source identifier ("s") and line ("l") at levels 1 and 2
	print(debug.info(1, "sl"))  --> fnA() 3
	print(debug.info(2, "sl"))  --> fnA() 7
end

fnA()

Note that this function is similar to debug.getinfo, an unavailable part of the standard Lua library which serves a similar purpose.

Allows programmatic inspection of the call stack. This function differs from debug.traceback() in that it guarantees the format of the data it returns. This is useful for general logging and filtering purposes as well as for sending the data to systems expecting structured input, such as crash aggregation.

local function fnA()

end

local function fnB()

end

-- Output line ("l"), name ("n"), and identifier ("f") for both fnA() and fnB()
print(debug.info(fnA, "lnf"))  --> 1 fnA function: 0x75e3d3c398a81252
print(debug.info(fnB, "lnf"))  --> 5 fnB function: 0x6022a6dc5ccf4ab2

Note that this function is similar to debug.getinfo, an unavailable part of the standard Lua library which serves a similar purpose.

Allows programmatic inspection of the call stack. This function differs from debug.traceback() in that it guarantees the format of the data it returns. This is useful for general logging and filtering purposes as well as for sending the data to systems expecting structured input, such as crash aggregation.

local function fnA()
	-- Output source identifier ("s") and line ("l") at levels 1 and 2
	print(debug.info(1, "sl"))  --> fnA() 3
	print(debug.info(2, "sl"))  --> fnA() 7
end

fnA()

Note that this function is similar to debug.getinfo, an unavailable part of the standard Lua library which serves a similar purpose.

Starts profiling for a MicroProfiler label.

Stops profiling for the most recent MicroProfiler label that debug.profilebegin() opened.

Returns the name of the current thread's active memory category.

Assigns a custom tag name to the current thread's memory category in the Developer Console. Useful for analyzing memory usage of multiple threads in the same script which would otherwise be grouped together under the same tag/name. Returns the name of the current thread's previous memory category.

Resets the tag assigned by debug.setmemorycategory() to the automatically assigned value (typically, the script name).

Displays a table of native code size of individual functions and scripts. This function is only available in the Command Bar in Studio. More details can be found on the Native Code Generation page.