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

47 lines
1.5 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>SetVertexXY</title>
<category>Objects</category>
<subcat>Vertices</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>index</name>
<desc>Vertex number</desc>
</param>
<param>
<type>int</type>
<name>xpos</name>
<desc>Desired X offset of the vertex.</desc>
</param>
<param>
<type>int</type>
<name>ypos</name>
<desc>Desired Y offset of the vertex.</desc>
</param>
</params>
</syntax>
<desc>Sets both X and Y position of a vertex.</desc>
<remark>Notice: with any vertex updated caused by stretching or rotation of the object (e.g. building or growth) the vertices will be reset to their original defined position unless a special vertex mode is selected.</remark>
<examples>
<example>
<code>GetCrew(0,0)-&gt;SetVertexXY(2, -5, -10);</code>
<text>Sets the third vertex of the first clonk of the first player to -5/-10.</text>
</example>
</examples>
<related>
<funclink>SetVertex</funclink>
<funclink>AddVertex</funclink>
<funclink>RemoveVertex</funclink>
</related>
</func>
<author>flgr</author><date>2002-01</date>
</funcs>