1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
<?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>GetScenarioVal</title>
<category>Get*Val</category>
<version>5.1 OC</version>
<syntax>
<rtype>any</rtype>
<params>
<param>
<type>string</type>
<name>entry</name>
<desc>Name of the entry to be retrieved.</desc>
</param>
<param>
<type>string</type>
<name>section</name>
<desc>Section of the entry to be retrieved. If not specified, all sections will be searched for an entry of the specified name.</desc>
<optional />
</param>
<param>
<type>int</type>
<name>entry_number</name>
<desc>Index of the value to be retrieved if an entry contains multiple values.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Returns the property value of the scenario by its name and section in the <emlink href="scenario/scenario.html">Scenario.txt</emlink>.</desc>
<remark>Warning: the retrieved values may differ from computer to computer and thus cause synchronization problems in network games.</remark>
<remark>Most useful applications for entry are already implemented in System.ocg/GetXVal.c.</remark>
<examples>
<example>
<code><funclink>Log</funclink>("You are playing \"%s\"!", GetScenTitle());</code>
<text>Displays the scenario title.</text>
</example>
</examples>
<related>
<funclink>GetDefCoreVal</funclink>
<funclink>GetObjectVal</funclink>
<funclink>GetObjectInfoCoreVal</funclink>
<funclink>GetActMapVal</funclink>
<funclink>GetPlayerVal</funclink>
<funclink>GetPlayerInfoCoreVal</funclink>
</related>
</func>
<author>PeterW</author><date>2002-04</date>
</funcs>
|
