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

27 lines
1.1 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>GetCon</title>
<category>Objects</category>
<subcat>Status</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Returns the completion of an object. With buildings this is the completion of the construction site. With animals and plants this is the current growth (see StretchGrowth/OverSize in <emlink href="definition/defcore.html">DefCore</emlink>).</desc>
<examples>
<example>
<code><funclink>if</funclink> (<funclink>GetCursor</funclink>()-&gt;GetCon() &gt; 50) <funclink>GetCursor</funclink>()-&gt;<funclink>DoCon</funclink>(-10);</code>
<text>Shrinks the selected clonk of the first player by 10% if he's not already at half size.</text>
</example>
</examples>
<related>
<funclink>SetCon</funclink>
<funclink>DoCon</funclink>
<funclink>OCF_Fullcon</funclink>
</related>
</func>
<author>Cucaracha</author><date>2002-05</date>
</funcs>