forked from Mirrors/openclonk
36 lines
1.2 KiB
XML
36 lines
1.2 KiB
XML
<?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>()->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>
|