MmLoadMenu
Revision as of 12:11, 3 December 2008 by imported>Speedo (→Notes)
Beta Function
This function has not been fully tested yet, and is not ready to be used in a released mod. It may not have the same function in later versions, may require the script to be recompiled, or simply may be removed. Use for testing purposes only until the author of the function says otherwise.
A command for MenuMate.
(Success:bool) mmLoadMenu filename:string
Loads and displays a menu from XML. Returns 1 if the menu was successfully loaded.
Notes
- All files must be under the path "..\My Documents\My Games\Oblivion\MenuMate\", however you my specify additional sub directories.
- Because only one menu may be shown at a time, MenuMate displays menus via a "first-in first-out" queue. There is no guarantee that your menu will be displayed as soon as this function is called. If, for example, there are three menus in the queue when you call this function, your menu will not display until the three menus ahead of it have completed. Generally, this should only be an issue for menus that display at the very beginning of a new game.
- Use mmGetStatus to check on the status of your menu.
- Menus are identified on a per-script basis. Once a script has loaded a menu, then any subsequent calls to mmLoadMenu will automatically fail until that menu is no longer in the queue.