File: GetName.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 (32 lines) | stat: -rw-r--r-- 1,052 bytes parent folder | download | duplicates (5)
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
<?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>GetName</title>
    <category>Objects</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>string</rtype>
      <params>
        <param>
          <type>bool</type>
          <name>truename</name>
	  <desc>Returns only the constant in which it was defined, ignoring the <code>Name</code> property.</desc>
        </param>
      </params>
    </syntax>
    <desc>Returns the name of a proplist. This is either the contents of the <code>Name</code> property, or if that doesn't exist or the true name was requested, the name of the constant in which it was defined.</desc>
    <examples>
      <example>
        <code>
static const Bee = { Buzz = func() {} };
func Poke(proplist animal) {
	if (animal->GetName(true) == "Bee") animal->Buzz();
}</code>
      </example>
    </examples>
  </func>
  <author>Günther</author><date>2014</date>
</funcs>