File: SetPicture.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 (54 lines) | stat: -rw-r--r-- 2,258 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
50
51
52
53
54
<?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>SetPicture</title>
    <category>Objects</category>
    <subcat>Display</subcat>
    <version>5.1 OC</version>
    <syntax>
      <rtype>void</rtype>
      <params>
        <param>
          <type>int</type>
          <name>x</name>
          <desc>X position of the top left corner of the new graphics rectangle.</desc>
        </param>
        <param>
          <type>int</type>
          <name>y</name>
          <desc>Y position of the top left corner of the new graphics rectangle.</desc>
        </param>
        <param>
          <type>int</type>
          <name>width</name>
          <desc>Width of the new graphics rectangle.</desc>
        </param>
        <param>
          <type>int</type>
          <name>height</name>
          <desc>Height of the new graphics rectangle.</desc>
        </param>
      </params>
    </syntax>
    <desc>Changes the representative picture of the object by setting it to a new source rectangle within the definition graphics. This picture is used e.g. in menus or the inventory. Also see the Picture entry in <emlink href="definition/defcore.html">DefCore.txt</emlink>.</desc>
    <examples>
      <example>
        <code>global func SetObjectPicture(idSrcDef, obj)
  {
  obj-&gt;SetPicture(<funclink>GetDefCoreVal</funclink>(&quot;Picture&quot;, &quot;DefCore&quot;, idSrcDef, 0),
             <funclink>GetDefCoreVal</funclink>(&quot;Picture&quot;, &quot;DefCore&quot;, idSrcDef, 1),
             <funclink>GetDefCoreVal</funclink>(&quot;Picture&quot;, &quot;DefCore&quot;, idSrcDef, 2),
             <funclink>GetDefCoreVal</funclink>(&quot;Picture&quot;, &quot;DefCore&quot;, idSrcDef, 3));
  obj-&gt;<funclink>SetGraphics</funclink>(0, idSrcDef);
  <funclink>return</funclink> 1;
  }</code>
        <text>Global function: changes the picture of obj to that of another object (Warning: this may make the game graphics or SolidMasks of the object invalid).</text>
      </example>
    </examples>
    <related><funclink>SetGraphics</funclink></related>
  </func>
  <author>Sven2</author><date>2003-06</date>
</funcs>