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

58 lines
1.7 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>GetVertex</title>
<category>Objects</category>
<subcat>Vertices</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>int</type>
<name>index</name>
<desc>Index of the vertex to be changed.</desc>
</param>
<param>
<type>int</type>
<name>data</name>
<desc>
<table>
<rowh>
<col>Value</col>
<col>Meaning</col>
</rowh>
<row>
<col>VTX_X</col>
<col>X coordinate of the vertex.</col>
</row>
<row>
<col>VTX_Y</col>
<col>Y coordinate of the vertex</col>
</row>
<row>
<col>VTX_CNAT</col>
<col><emlink href="definition/cnat.html">CNAT value</emlink> of the vertex.</col>
</row>
<row>
<col>VTX_Friction</col>
<col>Friction of the vertex.</col>
</row>
</table>
</desc>
</param>
</params>
</syntax>
<desc>Returns a coordinate of the specified vertex (see <emlink href="definition/defcore.html">DefCore.txt</emlink>). Coordinates are relative to the object center.</desc>
<related>
<funclink>SetVertex</funclink>
<funclink>GetVertexNum</funclink>
</related>
</func>
<author>jwk</author><date>2002-08</date>
<author>isilkor</author><date>2009-09</date>
</funcs>