forked from Mirrors/openclonk
47 lines
1.8 KiB
XML
47 lines
1.8 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>GetContact</title>
|
|
<category>Objects</category>
|
|
<subcat>Status</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 checked. -1 checks all vertices and returns the result as a bitmask of values combined with OR.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>dwCNAT</name>
|
|
<desc>Bit mask of CNAT values which determine which directions to check. If not specified, defaults to the vertices own CNAT mode, i.e. usually the one specified in VertexCNAT in the definition DefCore.txt file. If the vertex does not have any CNAT value, no direction is checked.</desc>
|
|
<optional />
|
|
</param>
|
|
</params>
|
|
</syntax>
|
|
<desc>Determines on which side individual or all vertices of an object are touching the landscape. Directions are specified using <emlink href="definition/cnat.html">CNAT values</emlink>.</desc>
|
|
<examples>
|
|
<example>
|
|
<code>protected func ControlUse(object caller)
|
|
{
|
|
if (caller->GetContact(-1) & CNAT_Bottom) caller-><funclink>Jump</funclink>();
|
|
<funclink>return</funclink> true;
|
|
}</code>
|
|
<text>Script for a jumping pill: if you use it, the clonk jumps if he is standing on the ground.</text>
|
|
</example>
|
|
</examples>
|
|
<related>
|
|
<funclink>Stuck</funclink>
|
|
<funclink>GetVertex</funclink>
|
|
<funclink>GetMaterial</funclink>
|
|
<emlink href="definition/cnat.html">Contact Attachment</emlink>
|
|
</related>
|
|
</func>
|
|
<author>Sven2</author><date>2005-01</date>
|
|
</funcs>
|