openclonk/docs/sdk/script/fn/StartScriptProfiler.xml

27 lines
1.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<title>StartScriptProfiler</title>
<category>Developer</category>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>id</type>
<name>definition_script</name>
<desc>If specified, only script functions of the given object definition are measured.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Starts the script profiler.</desc>
<remark>The script profiler can be used to measure how much processing time the scripting engine is using for executing certain script functions. This can be useful to find out which parts of a script are mainly slowing down execution in larger scenarios. The profiler measures the execution time between the commands StartScriptProfiler and StopScriptProfiler.</remark>
<related><funclink>StopScriptProfiler</funclink></related>
</func>
<author>Sven2</author><date>2007-03</date>
</funcs>