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

25 lines
915 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>GetEntrance</title>
<category>Objects</category>
<version>5.1 OC</version>
<syntax><rtype>bool</rtype></syntax>
<desc>Returns the current entrance status of an object. <code>true</code> if entering the object is currently allowed or <code>false</code> if it is disallowed.</desc>
<examples>
<example>
<code>if(<funclink>Contained</funclink>())
if(!<funclink>Contained</funclink>()-&gt;GetEntrance())
<funclink>Kill</funclink>();
</code>
<text>Extreme claustrophobia: if the entrance is blocked, commit suicide.</text>
</example>
</examples>
<related><funclink>SetEntrance</funclink></related>
</func>
<author>wipfmetz</author><date>2002-08</date>
</funcs>