AddDebugHook - Revision history

DColeman: /* Required Arguments */

2025-09-16T09:42:24Z

Required Arguments

← Older revision		Revision as of 09:42, 16 September 2025
Line 18:		Line 18:
	** preFunction		** preFunction
	** postFunction		** postFunction
	~~{{New feature/item\|3.0158\|1.5.5\|11856\|~~		** preEventFunction
	* preEventFunction		** postEventFunction
	* postEventFunction
	}}
	*'''callbackFunction:''' The function to call		*'''callbackFunction:''' The function to call
	** 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

DColeman: We cannot skip 'addDebugHook' anymore

2025-05-11T06:39:33Z

We cannot skip 'addDebugHook' anymore

← Older revision		Revision as of 06:39, 11 May 2025
Line 90:		Line 90:
	</syntaxhighlight>		</syntaxhighlight>

	~~{{New feature/item\|3.0152\|1.5.2\|7967\|~~
	~~This example shows how to disable addDebugHook~~
	~~<syntaxhighlight lang="lua">~~
	~~function onPreFunction( sourceResource, functionName, isAllowedByACL, luaFilename, luaLineNumber, ... )~~
	~~return "skip"~~
	~~end~~
	~~addDebugHook( "preFunction", onPreFunction, {"addDebugHook"} )~~
	~~</syntaxhighlight>~~
	}}

	==Changelog==		==Changelog==
Line 106:		Line 97:
	{{ChangelogItem\|1.5.2-9.07957\|Added option to skip original function/event <br/>Added ability to hook addDebugHook and removeDebugHook }}		{{ChangelogItem\|1.5.2-9.07957\|Added option to skip original function/event <br/>Added ability to hook addDebugHook and removeDebugHook }}
	{{ChangelogItem\|1.5.5-9.11856\|Added pre/postEventFunction hooks }}		{{ChangelogItem\|1.5.5-9.11856\|Added pre/postEventFunction hooks }}
			{{ChangelogItem\|1.6.0-9.22741\|Removed ability to skip 'addDebugHook' }}


	==See Also==		==See Also==
	{{Utility functions}}		{{Utility functions}}

Fernando187: Remove obsolete Requirements section

2024-11-07T17:12:30Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:12, 7 November 2024
Line 106:		Line 106:
	{{ChangelogItem\|1.5.2-9.07957\|Added option to skip original function/event <br/>Added ability to hook addDebugHook and removeDebugHook }}		{{ChangelogItem\|1.5.2-9.07957\|Added option to skip original function/event <br/>Added ability to hook addDebugHook and removeDebugHook }}
	{{ChangelogItem\|1.5.5-9.11856\|Added pre/postEventFunction hooks }}		{{ChangelogItem\|1.5.5-9.11856\|Added pre/postEventFunction hooks }}
	~~==Requirements==~~
	~~{{Requirements\|1.3.4-9.05939\|1.3.5-9.06054}}~~

	==See Also==		==See Also==
	{{Utility functions}}		{{Utility functions}}

Patrick2562: /* Example */

2020-08-07T23:48:48Z

Example

← Older revision		Revision as of 23:48, 7 August 2020
Line 93:		Line 93:
	This example shows how to disable addDebugHook		This example shows how to disable addDebugHook
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addDebugHook( "preFunction", onPreFunction, {"addDebugHook"} )~~
	function onPreFunction( sourceResource, functionName, isAllowedByACL, luaFilename, luaLineNumber, ... )		function onPreFunction( sourceResource, functionName, isAllowedByACL, luaFilename, luaLineNumber, ... )
	return "skip"		return "skip"
	end		end
			addDebugHook( "preFunction", onPreFunction, {"addDebugHook"} )
	</syntaxhighlight>		</syntaxhighlight>
	}}		}}

	==Changelog==		==Changelog==
	{{ChangelogHeader}}		{{ChangelogHeader}}

Ccw at 15:36, 26 July 2019

2019-07-26T15:36:48Z

← Older revision		Revision as of 15:36, 26 July 2019
Line 18:		Line 18:
	** preFunction		** preFunction
	** postFunction		** postFunction
	{{New feature/item\|3.~~0156~~\|1.5.5\|11856\|		{{New feature/item\|3.0158\|1.5.5\|11856\|
	* preEventFunction		* preEventFunction
	* postEventFunction		* postEventFunction
Line 39:		Line 39:
	postEvent( 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 )
	</syntaxhighlight>		</syntaxhighlight>
	{{New feature/item\|3.~~0155~~\|1.5.5\|11856\|		{{New feature/item\|3.0158\|1.5.5\|11856\|
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string preEventFunction ( resource eventResource, string eventName, element eventSource, element eventClient, string eventFilename, int eventLineNumber, resource functionResource, string functionFilename, int functionLineNumber, ...eventArgs )		string preEventFunction ( resource eventResource, string eventName, element eventSource, element eventClient, string eventFilename, int eventLineNumber, resource functionResource, string functionFilename, int functionLineNumber, ...eventArgs )

Myonlake at 23:56, 1 July 2018

2018-07-01T23:56:59Z

← Older revision		Revision as of 23:56, 1 July 2018
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">

Ccw at 19:45, 29 March 2018

2018-03-29T19:45:53Z

← Older revision		Revision as of 19:45, 29 March 2018
Line 18:		Line 18:
	** preFunction		** preFunction
	** postFunction		** postFunction
	{{New feature/item\|9.~~0156~~\|1.5.6\|11856\|		{{New feature/item\|9.0155\|1.5.5\|11856\|
	* preEventFunction		* preEventFunction
	* postEventFunction		* postEventFunction
Line 43:		Line 43:
	postEvent( 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 )
	</syntaxhighlight>		</syntaxhighlight>
	{{New feature/item\|3.~~0156~~\|1.5.6\|11856\|		{{New feature/item\|3.0155\|1.5.5\|11856\|
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string preEventFunction ( resource eventResource, string eventName, element eventSource, element eventClient, string eventFilename, int eventLineNumber, resource functionResource, string functionFilename, int functionLineNumber, ...eventArgs )		string preEventFunction ( resource eventResource, string eventName, element eventSource, element eventClient, string eventFilename, int eventLineNumber, resource functionResource, string functionFilename, int functionLineNumber, ...eventArgs )

Arran Fortuna: It's in 1.5.6

2018-02-20T22:50:40Z

It's in 1.5.6

← Older revision		Revision as of 22:50, 20 February 2018
Line 18:		Line 18:
	** preFunction		** preFunction
	** postFunction		** postFunction
	{{New feature/item\|9.~~0160~~\|1.6\|11856\|		{{New feature/item\|9.0156\|1.5.6\|11856\|
	* preEventFunction		* preEventFunction
	* postEventFunction		* postEventFunction
Line 43:		Line 43:
	postEvent( 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 )
	</syntaxhighlight>		</syntaxhighlight>
	{{New feature/item\|3.~~0160~~\|1.6\|11856\|		{{New feature/item\|3.0156\|1.5.6\|11856\|
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string preEventFunction ( resource eventResource, string eventName, element eventSource, element eventClient, string eventFilename, int eventLineNumber, resource functionResource, string functionFilename, int functionLineNumber, ...eventArgs )		string preEventFunction ( resource eventResource, string eventName, element eventSource, element eventClient, string eventFilename, int eventLineNumber, resource functionResource, string functionFilename, int functionLineNumber, ...eventArgs )

Necktrox at 09:44, 19 February 2018

2018-02-19T09:44:16Z

← Older revision		Revision as of 09:44, 19 February 2018
Line 6:		Line 6:
	Debug hooks are not recursive, so functions and events triggered inside the hook callback will not be traced.		Debug hooks are not recursive, so functions and events triggered inside the hook callback will not be traced.
	}}		}}

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 17:		Line 18:
	** preFunction		** preFunction
	** postFunction		** postFunction
			{{New feature/item\|9.0160\|1.6\|11856\|
			* preEventFunction
			* postEventFunction
			}}
	*'''callbackFunction :''' The function to call		*'''callbackFunction :''' The function to call
	{{New feature/item\|9.~~06054~~\|1.5.2\|7967\|		{{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
	}}		}}
Line 24:		Line 29:
	===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.~~06054~~\|1.5.2\|7967\|		{{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
	}}		}}
Line 33:		Line 38:
	==Callback parameters==		==Callback parameters==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string preFunction( resource sourceResource, string functionName, bool isAllowedByACL, string luaFilename, int luaLineNumber, functionArguments )		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 )		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 )		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 )		postEvent( resource sourceResource, string eventName, element eventSource, element eventClient, string luaFilename, int luaLineNumber, ...eventArguments )
	</syntaxhighlight>		</syntaxhighlight>
			{{New feature/item\|3.0160\|1.6\|11856\|
			<syntaxhighlight lang="lua">
			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 )
			</syntaxhighlight>
			}}

	==Example==		==Example==
Line 84:		Line 95:


	{{New feature/item\|9.~~06054~~\|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">
Line 98:		Line 109:
	{{ChangelogItem\|1.3.5-9.06142\|Added option to restrict to specified functions and events }}		{{ChangelogItem\|1.3.5-9.06142\|Added option to restrict to specified functions and events }}
	{{ChangelogItem\|1.5.2-9.07957\|Added option to skip original function/event <br/>Added ability to hook addDebugHook and removeDebugHook }}		{{ChangelogItem\|1.5.2-9.07957\|Added option to skip original function/event <br/>Added ability to hook addDebugHook and removeDebugHook }}
			{{ChangelogItem\|1.5.5-9.11856\|Added pre/postEventFunction hooks }}
	==Requirements==		==Requirements==
	{{Requirements\|1.3.4-9.05939\|1.3.5-9.06054}}		{{Requirements\|1.3.4-9.05939\|1.3.5-9.06054}}

GTX at 21:34, 19 May 2017

2017-05-19T21:34:43Z

← Older revision		Revision as of 21:34, 19 May 2017
Line 19:		Line 19:
	*'''callbackFunction :''' The function to call		*'''callbackFunction :''' The function to call
	{{New feature/item\|9.06054\|1.5.2\|7967\|		{{New feature/item\|9.06054\|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
	}}		}}

Line 25:		Line 25:
	*'''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.06054\|1.5.2\|7967\|		{{New feature/item\|9.06054\|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
	}}		}}