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

32 lines
1.3 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>GainMissionAccess</title>
<category>System</category>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>string</type>
<name>password</name>
<desc>Password to be added to the list.</desc>
</param>
</params>
</syntax>
<desc>Adds a password to the list of gained mission access passwords. All players on this computer can then start scenarios which require this password (defined in Scenario.txt). In a sequence of mission scenarios each scenario should give access to the next one.</desc>
<remark>If the engine runs in developer mode, stored registry information is not properly updated. To test this function, start the engine in player mode.</remark>
<examples>
<example>
<code>GainMissionAccess(&quot;WipfeMonsterSchnee&quot;);</code>
<text>Gives the mission password WipfeMosterSchnee to the player.</text>
</example>
</examples>
<related><funclink>GetMissionAccess</funclink></related>
</func>
<author>Sven2</author><date>2001-11</date>
</funcs>