luadocs/content/lua.scripts.api.manual/dtutils.debug/new_tracepoint.md
Bill Ferguson b69d752221 [lua scripts] created manual from script comments
[lua scripts api] created manual from embedded library documentation

[lua api] created stub to contain lua api manual
2020-12-12 15:14:19 -05:00

820 B

title id weight draft author
new_tracepoint new-tracepoint 30 false people

NAME

new_tracepoint

SYNOPSIS

create a function returning a tracepoint

USAGE

local dd = require "lib/dtutils.debug"
local result = dd.new_tracepoint(name, ...)

name - string - the name of the tracepoint to print out
... - arguments - variables to dump the contents of

DESCRIPTION

new_tracepoint returns a tracepoint function with the given name. This is mainly used to debug callbacks.

RETURN VALUE

result - function - a function that returns the result of a tracepoint

EXAMPLE

register_event(event, dd.new_tracepoint("hit callback"))

will print the following each time the callback is called

**** hit callback ****
<all the callback's parameters dumped>