File: ShowInfo.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 (35 lines) | stat: -rw-r--r-- 1,206 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
<?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>ShowInfo</title>
    <category>Objects</category>
    <subcat>Menu</subcat>
    <version>5.1 OC</version>
    <syntax>
      <rtype>bool</rtype>
    </syntax>
    <desc>Displays the description text of an object in a popup window (a menu window).</desc>
    <remark>The information window's background will be the definition image of the obect.</remark>
    <examples>
      <example>
        <code>func ControlSpecial()
  {
	if(!<funclink>Contents</funclink>()) return;
  <funclink>Contents</funclink>()-&gt;ShowInfo();
  }</code>
        <text>A feature for a special clonk: pressing a (to be defined) 'special' key will display the description of the first inventory item in a popup window.</text>
      </example>
    </examples>
    <related>
      <funclink>SetCommand</funclink>
      <funclink>GetDesc</funclink>
      <funclink>CreateMenu</funclink>
      <funclink>AddMenuItem</funclink>
      <funclink>CloseMenu</funclink>
    </related>
  </func>
  <author>Sven2</author><date>2002-08</date>
</funcs>