File: SetProperty.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 (38 lines) | stat: -rw-r--r-- 1,178 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
<?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>SetProperty</title>
    <category>Objects</category>
    <subcat>Properties</subcat>
    <version>5.1 OC</version>
    <syntax>
      <rtype>bool</rtype>
      <params>
        <param>
          <type>string</type>
          <name>key</name>
          <desc>Property to be set.</desc>
          <optional />
        </param>
        <param>
          <type>any</type>
          <name>value</name>
          <desc>Value to set the property to.</desc>
          <optional />
        </param>
        <param>
          <type>proplist</type>
          <name>obj</name>
          <desc>Object to be changed. Can be <code>nil</code> in local calls.</desc>
          <optional />
        </param>
      </params>
    </syntax>
    <desc>Sets the property <code>key</code> of <code>obj</code> to <code>value</code>. The property does not have to exist beforehand.</desc>
    <related><funclink>GetProperty</funclink></related>
  </func>
  <author>Günther</author><date>2009-05</date>
</funcs>