Difference between revisions of "Category:MenuMate"
Jump to navigation
Jump to search
imported>Speedo (updated) |
imported>Speedo (updated) |
||
| Line 14: | Line 14: | ||
|OBSEname = MenuMate | |OBSEname = MenuMate | ||
}} | }} | ||
__NOTOC__ | |||
==Tutorial== | ==Tutorial== | ||
| Line 23: | Line 25: | ||
Each menu created by MenuMate consists of various elements, all of which are defined within the XML file. Each menu must be defined within a single XML file, and each XML file may contain only one menu. | Each menu created by MenuMate consists of various elements, all of which are defined within the XML file. Each menu must be defined within a single XML file, and each XML file may contain only one menu. | ||
===Elements=== | |||
The elements are: | The elements are: | ||
*[[Menu_(MenuMate)|Menu]] - An element which defines all of the dialogs contained within your menu. | *[[Menu_(MenuMate)|Menu]] - An element which defines all of the dialogs contained within your menu. | ||
*[[Dialog_(MenuMate)|Dialog]] - A dialog is a single screen which is displayed to the player, comperable to a [[MessageBox]]. There is no limit on the number of dialogs a menu may contain. | *[[Dialog_(MenuMate)|Dialog]] - A dialog is a single screen which is displayed to the player, comperable to a [[MessageBox]]. There is no limit on the number of dialogs a menu may contain. | ||
*[[Button_(MenuMate)|Button]] - Defines a single button within a dialog. Each dialog must contain at least one button, and may contain a maximum of ten buttons. | *[[Button_(MenuMate)|Button]] - Defines a single button within a dialog. Each dialog must contain at least one button, and may contain a maximum of ten buttons. | ||
===Variables=== | |||
In several places throughout this documentation, the use of variables is referred to. When use in the XML, you must give the '''name''' of the variable you wish to use. You '''''may not''''' use the ObjectName.VariableName syntax for these variable. The variable '''''must''''' be located within the script which calls [[mmLoadMenu]] to display the menu. | |||
==Miscellaneous== | ==Miscellaneous== | ||
*If you use any variables at all, at any point in your menu, then you '''can ''not'' use a magic effect script to display the menu'''. | |||
*Be sure that you use [[mmGetStatus]] to be sure that your menu has completed successfully before using settings or information from it. | |||
*All XML files must be located under the path "..\My Documents\My Games\Oblivion\MenuMate\", though you may specify additional sub-folders within that directory. | *All XML files must be located under the path "..\My Documents\My Games\Oblivion\MenuMate\", though you may specify additional sub-folders within that directory. | ||
*MenuMate saves '''no''' additional data to the hard drive, and uses little memory in game. Your menu is loaded when you request that it be displayed, and is cleared from memory when it exits. | *MenuMate saves '''no''' additional data to the hard drive, and uses little memory in game. Your menu is loaded when you request that it be displayed, and is cleared from memory when it exits. | ||
Revision as of 20:54, 29 November 2008
| MenuMate | |
|---|---|
| Author(s) | |
| Current Version | 1 (GetPluginVersion returns 1) |
| Description |
MenuMate significantly simplifies the create of complex in-game menus. It completely eliminates the need for complex scripts to display and process menus, instead allowing you to define your menu in an XML file and display it in game with a single command. |
| Installation |
|
| Download |
todo |
| Source Code |
Not Available |
| Discussions |
todo |
| OBSE Name | "MenuMate"
(for use with IsPluginInstalled/GetPluginVersion) |
Tutorial
General Information
For general information about XML, see Wikipedia
Each menu created by MenuMate consists of various elements, all of which are defined within the XML file. Each menu must be defined within a single XML file, and each XML file may contain only one menu.
Elements
The elements are:
- Menu - An element which defines all of the dialogs contained within your menu.
- Dialog - A dialog is a single screen which is displayed to the player, comperable to a MessageBox. There is no limit on the number of dialogs a menu may contain.
- Button - Defines a single button within a dialog. Each dialog must contain at least one button, and may contain a maximum of ten buttons.
Variables
In several places throughout this documentation, the use of variables is referred to. When use in the XML, you must give the name of the variable you wish to use. You may not use the ObjectName.VariableName syntax for these variable. The variable must be located within the script which calls mmLoadMenu to display the menu.
Miscellaneous
- If you use any variables at all, at any point in your menu, then you can not use a magic effect script to display the menu.
- Be sure that you use mmGetStatus to be sure that your menu has completed successfully before using settings or information from it.
- All XML files must be located under the path "..\My Documents\My Games\Oblivion\MenuMate\", though you may specify additional sub-folders within that directory.
- MenuMate saves no additional data to the hard drive, and uses little memory in game. Your menu is loaded when you request that it be displayed, and is cleared from memory when it exits.
Pages in category "MenuMate"
The following 7 pages are in this category, out of 7 total.