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

46 lines
1.5 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>Hostile</title>
<category>Player</category>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>player1</name>
<desc>First player</desc>
</param>
<param>
<type>int</type>
<name>player2</name>
<desc>Second player</desc>
</param>
<param>
<type>bool</type>
<name>check_one_way</name>
<desc>If <code>true</code>, checks only if player1 is hostile towards player2 but not in reverse.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Determines whether two players are enemies. Two players will be opposed if at least one of them has declared hostility towards the other.</desc>
<examples>
<example>
<code>protected func RejectEntrance(object other)
{
<funclink>return</funclink> !<funclink>Hostile</funclink>(<funclink>GetOwner</funclink>(), <funclink>GetOwner</funclink>(other));
}</code>
<text>The object can only be collected by friendly players.</text>
</example>
</examples>
<related><funclink>SetHostility</funclink></related>
</func>
<author>Sven2</author><date>2001-11</date>
<author>Clonkonaut</author><date>2008-04</date>
</funcs>