AddDebugHook: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 9: Line 9:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool addDebugHook( string hookType, function callbackFunction[, table nameList ] )
bool addDebugHook ( string hookType, function callbackFunction [, table nameList ] )
</syntaxhighlight>
</syntaxhighlight>


Line 18: Line 18:
** preFunction
** preFunction
** postFunction
** postFunction
{{New feature/item|9.0155|1.5.5|11856|
{{New feature/item|3.0156|1.5.5|11856|
* preEventFunction
* preEventFunction
* postEventFunction
* postEventFunction
}}
}}
*'''callbackFunction :''' The function to call
*'''callbackFunction:''' The function to call
{{New feature/item|9.0152|1.5.2|7967|
** Returning the string "skip" from the callback function will cause the original function/event to be skipped
* Returning the string "skip" from the callback function will cause the original function/event to be skipped
}}


===Optional Arguments===  
===Optional Arguments===  
*'''nameList:''' Table of strings for restricting which functions and events the hook will be triggered on
*'''nameList:''' Table of strings for restricting which functions and events the hook will be triggered on
{{New feature/item|9.0152|1.5.2|7967|
** addDebugHook and removeDebugHook will only be hooked if they are specified in the name list
* addDebugHook and removeDebugHook will only be hooked if they are specified in the name list
}}


===Returns===
===Returns===
Line 94: Line 90:
</syntaxhighlight>
</syntaxhighlight>


 
{{New feature/item|3.0152|1.5.2|7967|
{{New feature/item|9.0152|1.5.2|7967|
This example shows how to disable addDebugHook
This example shows how to disable addDebugHook
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">

Revision as of 23:56, 1 July 2018

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

Debug hooks are not recursive, so functions and events triggered inside the hook callback will not be traced.

Syntax

bool addDebugHook ( string hookType, function callbackFunction [, table nameList ] )

Required Arguments

  • hookType: The type of hook to add. This can be:
    • preEvent
    • postEvent
    • preFunction
    • postFunction
  • preEventFunction
  • postEventFunction
  • callbackFunction: The function to call
    • Returning the string "skip" from the callback function will cause the original function/event to be skipped

Optional Arguments

  • nameList: Table of strings for restricting which functions and events the hook will be triggered on
    • addDebugHook and removeDebugHook will only be hooked if they are specified in the name list

Returns

Returns true if the hook was successfully added, or false otherwise.

Callback parameters

string preFunction( resource sourceResource, string functionName, bool isAllowedByACL, string luaFilename, int luaLineNumber, ...functionArguments )
       postFunction( resource sourceResource, string functionName, bool isAllowedByACL, string luaFilename, int luaLineNumber, ...functionArguments )
string preEvent( resource sourceResource, string eventName, element eventSource, element eventClient, string luaFilename, int luaLineNumber, ...eventArguments )
       postEvent( resource sourceResource, string eventName, element eventSource, element eventClient, string luaFilename, int luaLineNumber, ...eventArguments )

string preEventFunction ( resource eventResource, string eventName, element eventSource, element eventClient, string eventFilename, int eventLineNumber, resource functionResource, string functionFilename, int functionLineNumber, ...eventArgs )
       postEventFunction ( resource eventResource, string eventName, element eventSource, element eventClient, string eventFilename, int eventLineNumber, resource functionResource, string functionFilename, int functionLineNumber, ...eventArgs )

Example

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 )

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)

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

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

This example shows how to disable addDebugHook 

addDebugHook( "preFunction", onPreFunction, {"addDebugHook"} )
function onPreFunction( sourceResource, functionName, isAllowedByACL, luaFilename, luaLineNumber, ... )
    return "skip"
end

Changelog

Version Description
1.3.5-9.06054 Added clientside
1.3.5-9.06142 Added option to restrict to specified functions and events
1.5.2-9.07957 Added option to skip original function/event
Added ability to hook addDebugHook and removeDebugHook
1.5.5-9.11856 Added pre/postEventFunction hooks

Requirements

This template will be deleted.

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/AddDebugHook?oldid=55581"