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

31 lines
878 B
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>SetGameSpeed</title>
<category>Global</category>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>game_speed</name>
<desc>Game speed in FPS (frames per second). If this parameter is omitted or <code>false</code>, the default game speed of 38 FPS is used.</desc>
<optional/>
</param>
</params>
</syntax>
<desc>Sets game speed.</desc>
<examples>
<example>
<code>SetGameSpeed(10);</code>
<text>The game runs in slow motion.</text>
</example>
</examples>
</func>
<author>PeterW</author><date>2002-05</date>
</funcs>