Skip to main content

TracebackUtils

A collection of utilities related to debug library on Roblox.

Functions​

GetCallingFunctionId​

</>
TracebackUtils.GetCallingFunctionId() → string

Returns the memory id of the function a level above.

local function TestFunction()
	print(TracebackUtils.GetCallingFunctionId()) -- Prints the memory ID of Init()
end

local function Init()
	TestFunction()
end

Init()

GetCallingFunctionName​

</>
TracebackUtils.GetCallingFunctionName() → string

Returns the name of the function a level above.

local function TestFunction()
	print(TracebackUtils.GetCallingFunctionName()) -- Prints "Init"
end

local function Init()
	TestFunction()
end

Init()

GetShallowTraceback​

</>
TracebackUtils.GetShallowTraceback() → string

Equivalent to calling debug.traceback() without any message or level.

ErrorTraceback​

</>
TracebackUtils.ErrorTraceback(ErrorMessage: string) → ()

Throws an error with a traceback string.

WarnTraceback​

</>
TracebackUtils.WarnTraceback(WarningMessage: string) → ()

Throws a warning with a traceback string.

Show raw api
{
    "functions": [
        {
            "name": "GetCallingFunctionId",
            "desc": "Returns the memory id of the function a level above.\n\n```lua\nlocal function TestFunction()\n\tprint(TracebackUtils.GetCallingFunctionId()) -- Prints the memory ID of Init()\nend\n\nlocal function Init()\n\tTestFunction()\nend\n\nInit()\n```",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 26,
                "path": "src/Packages/_Index/miagobble_traceback-utils@1.0.1/traceback-utils/init.luau"
            }
        },
        {
            "name": "GetCallingFunctionName",
            "desc": "Returns the name of the function a level above.\n\n```lua\nlocal function TestFunction()\n\tprint(TracebackUtils.GetCallingFunctionName()) -- Prints \"Init\"\nend\n\nlocal function Init()\n\tTestFunction()\nend\n\nInit()\n```",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 49,
                "path": "src/Packages/_Index/miagobble_traceback-utils@1.0.1/traceback-utils/init.luau"
            }
        },
        {
            "name": "GetShallowTraceback",
            "desc": "Equivalent to calling debug.traceback() without any message or level.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 59,
                "path": "src/Packages/_Index/miagobble_traceback-utils@1.0.1/traceback-utils/init.luau"
            }
        },
        {
            "name": "ErrorTraceback",
            "desc": "Throws an error with a traceback string.",
            "params": [
                {
                    "name": "ErrorMessage",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 67,
                "path": "src/Packages/_Index/miagobble_traceback-utils@1.0.1/traceback-utils/init.luau"
            }
        },
        {
            "name": "WarnTraceback",
            "desc": "Throws a warning with a traceback string.",
            "params": [
                {
                    "name": "WarningMessage",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 75,
                "path": "src/Packages/_Index/miagobble_traceback-utils@1.0.1/traceback-utils/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TracebackUtils",
    "desc": "A collection of utilities related to debug library on Roblox.",
    "source": {
        "line": 6,
        "path": "src/Packages/_Index/miagobble_traceback-utils@1.0.1/traceback-utils/init.luau"
    }
}