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

29 lines
1.3 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>GetTime</title>
<category>System</category>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Returns the time passed since operating system start. Can be used for exact time measurement.</desc>
<remark>As operating system times will vary on different computers, this function will always return 0 in a network game or playback to avoid synchronization errors.</remark>
<examples>
<example>
<code>func TestCos()
{
if(<funclink>IsNetwork</funclink>()) <funclink>return</funclink>(<funclink>Log</funclink>(&quot;TestCos doesn't work in a network game!&quot;));
var start_time = GetTime();
for(var i = 0; i &lt; 100; i++) <funclink>Cos</funclink>(i, 100);
var time = GetTime() - start_time;
<funclink>Log</funclink>(&quot;A call to Cos takes %d.%02d ms&quot;, time / 100, time % 100);
}</code>
<text>This function checks the performance of the function "<funclink>Cos</funclink>". To do this, it executes the function 100 times and calculates the time the process took using GetTime().</text>
</example>
</examples>
</func>
<author>Peter</author><date>2002-08</date>
</funcs>