openclonk/docs/sdk/script/fn/SelectMenuItem.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>SelectMenuItem</title>
    <category>Objects</category>
    <subcat>Menu</subcat>
    <version>4.9.1.0 GWE</version>
    <syntax>
      <rtype>bool</rtype>
      <params>
        <param>
          <type>int</type>
          <name>number</name>
          <desc>Number of the menu item which is to be selected. The first entry is number 0.</desc>
        </param>
      </params>
    </syntax>
    <desc>Sets menu selection in an object menu.</desc>
    <examples>
      <example>
        <text>SelectMenuItem can be used in conjunction with <funclink>GetMenuSelection</funclink> to update menu entries without losing menu item selection.</text>
        <code>var selection = -1;
// Menu bereits geöffnet?
if(<funclink>GetMenu</funclink>())
  selection = <funclink>GetMenuSelection</funclink>();

// [ Hier Menu (neu) erstellen... ]

// Selektion wiederherstellen?
if(selection &gt;= 0)
  SelectMenuItem(selection);</code>
      </example>
    </examples>
    <related>
      <funclink>GetMenuSelection</funclink>
      <funclink>GetMenu</funclink>
      <funclink>CreateMenu</funclink>
      <funclink>AddMenuItem</funclink>
    </related>
  </func>
  <author>PeterW</author><date>2002-10</date>
</funcs>