Needs checking

This function was partially migrated from the old wiki. Please review manually:

• Missing section: Callback parameters

This page is incomplete! Help wanted!

Please finish this page using the corresponding Old Wiki article.
Go to Contribution guidelines for more information.

---

This function allows tracing of MTA functions and events. It should only be used when debugging scripts as it may degrade script performance.

Syntax

 addDebugHook ( )

Code Examples

Example 1 Example 2 Example 3

server

This example will dump info about all triggered events:

function onPreEvent( sourceResource, eventName, eventSource, eventClient, luaFilename, luaLineNumber, ... )
    local args = { ... }
    local srctype = eventSource and getElementType(eventSource)
    local resname = sourceResource and getResourceName(sourceResource)
    local plrname = eventClient and getPlayerName(eventClient)
    outputDebugString( "preEvent"
        .. " " .. tostring(resname)
        .. " " .. tostring(eventName)
        .. " source:" .. tostring(srctype)
        .. " player:" .. tostring(plrname)
        .. " file:" .. tostring(luaFilename)
        .. "(" .. tostring(luaLineNumber) .. ")"
        .. " numArgs:" .. tostring(#args)
        .. " arg1:" .. tostring(args[1])
        )
end
addDebugHook( "preEvent", onPreEvent )

server

This example will dump info about all called MTA functions:

function onPreFunction( sourceResource, functionName, isAllowedByACL, luaFilename, luaLineNumber, ... )
    local args = { ... }
    local resname = sourceResource and getResourceName(sourceResource)
    outputDebugString( "preFunction"
        .. " " .. tostring(resname)
        .. " " .. tostring(functionName)
        .. " allowed:" .. tostring(isAllowedByACL)
        .. " file:" .. tostring(luaFilename)
        .. "(" .. tostring(luaLineNumber) .. ")"
        .. " numArgs:" .. tostring(#args)
        .. " arg1:" .. tostring(args[1])
        )
end
addDebugHook( "preFunction", onPreFunction)

server

This example adds a hook which will only be triggered for the named functions

addDebugHook( "preFunction", onPreFunction, {"setElementPosition","loadstring"} )

See Also

Utility Functions

• addDebugHook
• bitAnd
• bitArShift
• bitExtract
• bitLRotate
• bitLShift
• bitNot
• bitOr
• bitReplace
• bitRRotate
• bitRShift
• bitTest
• bitXor
• createTrayNotification
• debugSleep
• decodeString
• deref
• downloadFile
• encodeString
• fromJSON
• generateKeyPair
• getColorFromString
• getDevelopmentMode
• getDistanceBetweenPoints2D
• getDistanceBetweenPoints3D
• getEasingValue
• getFPSLimit
• getKeyboardLayout
• getLocalization
• getNetworkStats
• getNetworkUsageData
• getPerformanceStats
• getProcessMemoryStats
• getRealTime
• getServerIp
• getTickCount
• getTimerDetails
• getTimers
• gettok
• getUserdataType
• getVersion
• hash
• inspect
• interpolateBetween
• iprint
• isOOPEnabled
• isShowCollisionsEnabled
• isShowSoundEnabled
• isTimer
• isTimerPaused
• isTransferBoxAlwaysVisible
• isTransferBoxVisible
• isTrayNotificationEnabled
• killTimer
• md5
• passwordHash
• passwordVerify
• pregFind
• pregMatch
• pregReplace
• ref
• removeDebugHook
• resetTimer
• setClipboard
• setDevelopmentMode
• setFPSLimit
• setTimer
• setTimerPaused
• setTransferBoxVisible
• setWindowFlashing
• sha256
• showCol
• showSound
• split
• teaDecode
• teaEncode
• tocolor
• toJSON
• utfChar
• utfCode
• utfLen
• utfSeek
• utfSub

Reference

• Scripting Functions