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

23 lines
912 B
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>GetMenuSelection</title>
<category>Objects</category>
<subcat>Menu</subcat>
<version>5.1 OC</version>
<syntax><rtype>int?</rtype></syntax>
<desc>Determines the currently selected menu entry of the currently open menu of an object, or <code>nil</code> if no menu is open.</desc>
<examples>
<example>
<code><funclink>Log</funclink>(&quot;Current selection: entry %d...&quot;, <funclink>GetCursor</funclink>(0)-&gt;GetMenuSelection();</code>
<text>Writes to the log which menu entry the player has currently selected.</text>
</example>
</examples>
<related><funclink>CreateMenu</funclink></related>
</func>
<author>Sven2</author><date>2001-11</date>
</funcs>