File: GetObjectVal.xml

package info (click to toggle)
openclonk 8.1-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 169,520 kB
  • sloc: cpp: 180,479; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 145; sh: 101; javascript: 34
file content (49 lines) | stat: -rw-r--r-- 1,657 bytes parent folder | download | duplicates (7)
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
<?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>GetObjectVal</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 by its name in the Objects.txt.</desc>
    <remark>Most useful applications for entry are already implemented in System.ocg/GetXVal.c.</remark>
    <examples>
      <example>
        <text>see <funclink>GetDefCoreVal</funclink></text>
      </example>
    </examples>
    <related>
      <funclink>GetDefCoreVal</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>