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

32 lines
940 B
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>DoBreath</title>
<category>Objects</category>
<subcat>Living Beings</subcat>
<version>1.0 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>change</name>
<desc>Change of the breath value in frames.</desc>
</param>
</params>
</syntax>
<desc>Changes the breath value of an object.</desc>
<examples>
<example>
<code>GetCursor()-&gt;DoBreath(GetCursor().MaxBreath / 2);</code>
<text>Gives 50% more breath to the selected clonk of the first player.</text>
</example>
</examples>
<related><funclink>GetBreath</funclink></related>
</func>
<author>Sven2</author><date>2001-11</date>
</funcs>