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

46 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>goto</title>
<category>Script</category>
<version>5.1 OC</version>
<syntax>
<rtype>void</rtype>
<params>
<param>
<type>int</type>
<name>counter</name>
<desc>New value for the script counter. The next scenario script function called will be ScriptXXX.</desc>
</param>
</params>
</syntax>
<desc>Sets the script counter for scenario scripts to the specified value. The script counter is responsible for calling the ScriptXXX functions in a scenario script. This does not apply to object scripts - those should be using TimerCall or ActMaps with StartCall/PhaseCall/EndCall.</desc>
<examples>
<example>
<code>
func Initialize()
{
// Start script counter
<funclink>ScriptGo</funclink>(1);
}
func Script10()
{
// Create firestones
<funclink>CastObjects</funclink>(Firestone,10,200, <funclink>Random</funclink>(<funclink>LandscapeWidth</funclink>()), 20);
goto(0);
}</code>
<text>A scenario script: a typical flint rain. Every 100 Frames 10 flints are created.</text>
</example>
</examples>
<related>
<funclink>ScriptGo</funclink>
<funclink>ScriptCounter</funclink>
</related>
</func>
<author>jwk</author><date>2002-04</date>
</funcs>