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

47 lines
1.6 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>SetPosition</title>
<category>Objects</category>
<subcat>Position</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>void</rtype>
<params>
<param>
<type>int</type>
<name>x</name>
<desc>New X position of the object.</desc>
</param>
<param>
<type>int</type>
<name>y</name>
<desc>New Y position of the object.</desc>
</param>
<param>
<type>bool</type>
<name>check_bounds</name>
<desc>Only applies to objects using the <emlink href="definition/properties.html">BorderBound property</emlink>. Ensures that the position is always within the limits specified by the object.</desc>
<optional />
</param>
<param>
<type>int</type>
<name>prec</name>
<desc>Precision. Coordinates are divided by this value to enable movement to fractional positions. Defaults to 1.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Moves the object to the specified position. This will set the exact pixel position and any internal sub-pixel offsets will be reset.</desc>
<related>
<funclink>GetX</funclink>
<funclink>GetY</funclink>
</related>
</func>
<author>Sven2</author><date>2002-08</date>
<author>Clonkonaut</author><date>2008-04</date>
</funcs>