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

37 lines
1.4 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>GetMissionAccess</title>
<category>System</category>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>string</type>
<name>mission_access</name>
<desc>Mission access to be checked.</desc>
</param>
</params>
</syntax>
<desc>Determines whether the player already has the specified mission access password.</desc>
<remark>In a network game, this function always returns <code>false</code>. Otherwise differing local values might cause synchronization problems.</remark>
<examples>
<example>
<code><funclink>if</funclink> (!GetMissionAccess(&quot;DasWarHarteArbeit&quot;))
{
<funclink>GainMissionAccess</funclink>(&quot;DasWarHarteArbeit&quot;);
<funclink>Message</funclink>(&quot;Congratulations, you are here for the first time!&quot;);
}</code>
<text>Displays a message if the mission access password "DasWarHarteArbeit" was not yet gained and then gives this mission access.</text>
</example>
</examples>
<related><funclink>GainMissionAccess</funclink></related>
</func>
<author>Sven2</author><date>2001-11</date>
<author>matthes</author><date>2005-02</date>
</funcs>