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
52
53
54
55
56
57
58
59
60
61
62
63
|
<?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>GetDefCoreVal</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 an object definition by its name in the <emlink href="definition/defcore.html">DefCore.txt</emlink>.</desc>
<remark>If the requested entry is an id list (e.g. "Components" in DefCore.txt) an even entry_number will return the listed id and an uneven entry_number will return the matching count (see example).</remark>
<examples>
<example>
<code>var wdt = GetID()->GetDefCoreVal("Width", "DefCore");</code>
<text>Determines the width an object.</text>
</example>
<example>
<code><funclink>Log</funclink>(" A tools workshop requires the following material:");
for(var i = 0;; i++)
{
var id = GetDefCoreVal("Components", "DefCore", ToolsWorkshop, i*2);
if(!id) break;
var cnt = GetDefCoreVal("Components", "DefCore", ToolsWorkshop, i*2+1);
<funclink>Log</funclink>("%d x %s", cnt, id-><funclink>GetName</funclink>());
}</code>
<text>Determines the necessary components for construction of a workshop.<br/>The loop will run until GetDefCoreVal returns id <code>nil</code> which means the end of the list.</text>
</example>
</examples>
<related>
<funclink>GetObjectVal</funclink>
<funclink>GetObjectInfoCoreVal</funclink>
<funclink>GetActMapVal</funclink>
<funclink>GetScenarioVal</funclink>
<funclink>GetPlayerVal</funclink>
<funclink>GetPlayerInfoCoreVal</funclink>
</related>
</func>
<author>PeterW</author><date>2002-04</date>
</funcs>
|
