openclonk/docs/sdk/script/fn/GetMenu.xml

36 lines
1.4 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<!DOCTYPE funcs SYSTEM "../../../clonk.dtd">
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<title>GetMenu</title>
<category>Objekte</category><subcat>Men<EFBFBD></subcat>
<version>4.9.1.0 GWE</version>
<syntax>
<rtype>id?</rtype>
</syntax>
<desc>Liefert die ID des Men<65>s, falls das Objekt ein Men<65> ge<67>ffnet hat. Normalerweise ist das die ID des Men<65>symbols (symbol), wenn nicht bei <funclink>CreateMenu</funclink> explizit eine andere Men<65>-ID als idMenuID angegeben wurde. NONE bei keinem Symbol.</desc>
<remark>Ein R<>ckgabewert von nil bedeutet, dass kein g<>ltiges Symbol ermittelt werden konnte. Dies kann z.B. dann auftreten, wenn kein Men<65> ge<67>ffnet ist. Engineinterne Men<65>s (Kaufen, Verkaufen, etc.) geben keine g<>ltigen IDs zur<75>ck.</remark>
<examples>
<example>
<code>/* Wird bei klick auf Spezial aufgerufen */
protected func ControlSpecial()
{
/* <20>berhaupt ein Men<65> offen und ein Symbol angegeben? */
if(GetMenu())
/* Mutieren */
<funclink>ChangeDef</funclink>(GetMenu());
return(1);
}
</code>
<text>Zu einem Objekt mutieren, welches vom Symbol repr<70>sentiert wird.</text>
</example>
</examples>
<related>
<funclink>CreateMenu</funclink>
<funclink>CloseMenu</funclink>
</related>
</func>
<author>wipfmetz</author><date>August 2002</date>
</funcs>