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

33 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>SetDir</title>
<category>Objects</category>
<subcat>Activity</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>int</type>
<name>dir</name>
<desc>New direction. Predefined values: <funclink>DIR_Right</funclink> / <funclink>DIR_Left</funclink></desc>
</param>
</params>
</syntax>
<desc>Sets the direction of the object. If the object defines an action named "Turn", this action is executed after the call of this function.</desc>
<remark>SetDir affects the visual direction of an active object; to modify object motion use <funclink>SetComDir</funclink>.</remark>
<remark>If the object's action has more than two directions (see <emlink href="definition/actmap.html">the ActMap</emlink>), you can also use values other than just <funclink>DIR_Right</funclink> and <funclink>DIR_Left</funclink>.</remark>
<related>
<funclink>GetDir</funclink>
<funclink>DIR_Left</funclink>
<funclink>DIR_Right</funclink>
<funclink>SetAction</funclink>
</related>
</func>
<author>Newton</author><date>2013-11</date>
</funcs>