forked from Mirrors/openclonk
28 lines
895 B
XML
28 lines
895 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>GetOCF</title>
|
|
<category>Objects</category>
|
|
<subcat>OCF</subcat>
|
|
<version>5.1 OC</version>
|
|
<syntax><rtype>int</rtype></syntax>
|
|
<desc>Returns the Object Character Flag of an object. This value describes the current state of an object. The return value is a bit mask and can be compared with OCF_x values using &.</desc>
|
|
<examples>
|
|
<example>
|
|
<code>protected func Damage()
|
|
{
|
|
// object is burning?
|
|
if(GetOCF() & <funclink>OCF_OnFire</funclink>)
|
|
<funclink>Message</funclink>("Jippie, I am burning!");
|
|
}
|
|
</code>
|
|
<text>Masochist</text>
|
|
</example>
|
|
</examples>
|
|
</func>
|
|
<author>wipfmetz</author><date>2002-08</date>
|
|
</funcs>
|