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

30 lines
958 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>GetEnergy</title>
<category>Objects</category>
<version>1.0 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>bool</type>
<name>exact</name>
<desc>If <code>true</code>, the exact energy value is returned.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Returns the current energy value of an object. 100% representing the maximum physical value of 100,000</desc>
<remark>For living beings, \"energy\" stands for health, in buildings it stands for electrical charge.</remark>
<related>
<funclink>DoEnergy</funclink>
</related>
</func>
<author>jwk</author><date>2002-06</date>
<author>Marky</author><date>2018-12</date>
</funcs>