OutputDebugString

2013-11-15T19:53:22Z

Ploep: /* Example */

{{Server client function}}
__NOTOC__
This function outputs scripting debug messages, which can be read by enabling the debug textbox. The debug display level can then be set so that info or warning messages get filtered out.

==Syntax==
<syntaxhighlight lang="lua">
bool outputDebugString ( string text, [ int level=3, int red=255, int green=255, int blue=255 ] )
</syntaxhighlight>

===Required Arguments===
*'''text:''' the text to be output to the debug box.

===Optional Arguments===
{{OptionalArg}}
*'''level:''' the debug message level. Possible values are:
**'''0:''' Custom message
**'''1:''' Error message
**'''2:''' Warning message
**'''3:''' Information message (default)
*'''red:''' The amount of red in the color of the text. Default value is 255.
*'''green:''' The amount of green in the color of the text. Default value is 255.
*'''blue:''' The amount of blue in the color of the text. Default value is 255.
'''Note:''' Color values are only applied when debug level is 0.

===Returns===
Returns ''true'' if the debug message was successfully output, ''false'' if invalid arguments are specified.

==Example==
This script notifies when its resource has been loaded using a debug message:
<syntaxhighlight lang="lua">
function resourceStartNotify ( resourcename )
-- if the started resource is this one
if ( resourcename == getThisResource() ) then
-- send an info debug message as a notification
outputDebugString ( "Resource " .. getResourceName(resourcename) .. " loaded." )
end
end
addEventHandler( "onResourceStart", getRootElement(), resourceStartNotify )
</syntaxhighlight>

==See Also==
{{Server functions}}

Multi Theft Auto: Wiki - User contributions [en]

OutputDebugString