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

44 lines
1.2 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>SetSpeed</title>
<category>Objects</category>
<subcat>Movement</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>xdir</name>
<desc>Horizontal speed divided by precision.</desc>
</param>
<param>
<type>int</type>
<name>ydir</name>
<desc>Vertical speed divided by precision.</desc>
</param>
<param>
<type>int</type>
<name>precision</name>
<desc>Precision. Default 10 if not specified.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Sets the speed of the object.</desc>
<related>
<funclink>GetXDir</funclink>
<funclink>GetYDir</funclink>
<funclink>SetXDir</funclink>
<funclink>SetYDir</funclink>
<funclink>SetRDir</funclink>
<funclink>SetR</funclink>
</related>
</func>
<author>Newton</author><date>2009-07</date>
</funcs>