Modules/game/menu - Revision history

Aoineko at 22:12, 22 September 2025

2025-09-22T22:12:17Z

Aoineko: Aoineko moved page Modules/game menu to Modules/game/menu

2025-09-22T20:59:54Z

Aoineko moved page Modules/game menu to Modules/game/menu

Aoineko: Replaced content with "{{MODULE |name=game_menu |category=Gameplay |dependency1=input |dependency2=print |dependency3= |sample1=s_menu |sample2= |sample3= }}"

2024-01-04T23:21:06Z

Replaced content with "{{MODULE |name=game_menu |category=Gameplay |dependency1=input |dependency2=print |dependency3= |sample1=s_menu |sample2= |sample3= }}"

Aoineko: /* Dependencies */

2023-11-24T10:21:06Z

‎Dependencies

Aoineko: /* Exemple */

2023-10-31T23:55:33Z

‎Exemple

Aoineko: /* Menu item types */

2023-10-31T23:54:25Z

‎Menu item types

Aoineko: /* Usage */

2023-10-31T23:42:59Z

‎Usage

Aoineko: /* Usage */

2023-10-31T22:54:54Z

‎Usage

Aoineko: /* Usage */

2023-10-31T22:47:51Z

‎Usage

Aoineko: /* Usage */

2023-10-31T22:47:02Z

‎Usage

@@ Line 2: / Line 2: @@
 == Dependencies ==
 * {{MOD|input}}
 * {{MOD|print}}

@@ Line 77: / Line 77: @@
+  {
   	{ "Start",               MENU_ITEM_ACTION, MenuAction_Start, 1 }, // Entry to start a game (will trigger MenuAction_Start with 'value' parameter equal to '1')
-  	{ "Options",             MENU_ITEM_GOTO, NULL, MENU_OPTION },     // Entry to go to Option menu page
+  	{ "Options",             MENU_ITEM_GOTO, NULL, MENU_OPTION },     // Entry to go to Option menu page (page are defined using their index into the menu structure)
   	{ "Align",               MENU_ITEM_GOTO, NULL, MENU_ALIGN },      // Entry to go to Align menu page
   	{ NULL,                  MENU_ITEM_EMPTY, NULL, 0 },              // Blank entry to create a gap

@@ Line 62: / Line 62: @@
 === Menu item types ===
+Here's a list of possible menu entry types and how they use the 'Action' and 'Value' parameters:
-  MENU_ITEM_ACTION	// Execute callback function defined in 'Action'
+  MENU_ITEM_ACTION	// Execute callback function defined in 'Action' with 'Value' as a parameter
   MENU_ITEM_GOTO		// Change page to the one defined in 'Value'
   MENU_ITEM_INT		// Handle pointer to 8-bits integer defined in 'Action' (can be incremented or decremented)
@@ Line 69: / Line 69: @@
   MENU_ITEM_TEXT		// Handle pointer to zero-terminated string (non-interactive)
   MENU_ITEM_EMPTY		// Empty entry (used to create an empty gap in the menu)
-  MENU_ITEM_UPDATE	// Execute callback function defined in 'Action' every frame
+  MENU_ITEM_UPDATE	// Execute callback function defined in 'Action' with 'Value' as a parameter every frame
 === Exemple ===

← Older revision		Revision as of 23:42, 31 October 2023
Line 60:		Line 60:

	The menu system initialization function (<tt>Menu_Initialize</tt>) takes as its parameter an array of pages representing a whole menu.		The menu system initialization function (<tt>Menu_Initialize</tt>) takes as its parameter an array of pages representing a whole menu.
		+
		+	=== Menu item types ===
		+
		+	MENU_ITEM_ACTION // Execute callback function defined in 'Action'
		+	MENU_ITEM_GOTO // Change page to the one defined in 'Value'
		+	MENU_ITEM_INT // Handle pointer to 8-bits integer defined in 'Action' (can be incremented or decremented)
		+	MENU_ITEM_BOOL // Handle pointer to boolean defined in 'Action' (can be turned ON or OFF)
		+	MENU_ITEM_TEXT // Handle pointer to zero-terminated string (non-interactive)
		+	MENU_ITEM_EMPTY // Empty entry (used to create an empty gap in the menu)
		+	MENU_ITEM_UPDATE // Execute callback function defined in 'Action' every frame

	=== Exemple ===		=== Exemple ===

@@ Line 59: / Line 59: @@
 A page is generally composed of a list of entries, and a menu is composed of a list of pages.
-La fonction d'initialisation des
+The menu system initialization function (<tt>Menu_Initialize</tt>) takes as its parameter an array of pages representing a whole menu.
 == Annexe ==

@@ Line 1: / Line 1: @@
 {{MODULE
-|name=game_menu
+|name=game/menu
 |category=Gameplay
 |dependency1=input

← Older revision	Revision as of 20:59, 22 September 2025
(No difference)

@@ Line 1: / Line 1: @@
-The {{MOD|game_menu}} module automatically manages menus based on tables representing each page and its interactions.
+{{MODULE
+|name=game_menu
-== Dependencies ==
+|category=Gameplay
-Dependency on other modules:
+|dependency1=input
-* {{MOD|input}}
+|dependency2=print
-* {{MOD|print}}
+|dependency3=
+|sample1=s_menu
-== Settings ==
+|sample2=
-Modules can be customized into the project's <tt>msxgl_config.h</tt> file to fullfill your needs:
+|sample3=
- #define MENU_USE_DEFAULT_CALLBACK	TRUE		// Use default input/print callback
+}}

← Older revision		Revision as of 22:47, 31 October 2023
Line 58:		Line 58:

	A page is generally composed of a list of entries, and a menu is composed of a list of pages.		A page is generally composed of a list of entries, and a menu is composed of a list of pages.
		+
		+	La fonction d'initialisation des

	== Annexe ==		== Annexe ==

← Older revision		Revision as of 22:47, 31 October 2023
Line 35:		Line 35:

	== Usage ==		== Usage ==
		+	The module is data-driven, meaning that its behavior is completely determined by the data passed to it. The system is based on two structures.
		+
		+	Structure that represents an entry on a menu page:
		+	// Menu item structure
		+	typedef struct
		+	{
		+	const c8* Text; // Name of the item
		+	u8 Type; // Type of the item (see <MENU_ITEM_TYPE>)
		+	void* Action; // Action associated to the item (depends on item type)
		+	i16 Value; // Value associated to the item (depends on item type)
		+	} MenuItem;
		+
		+	Structure that represents a complete page:
		+	// Menu structure
		+	typedef struct
		+	{
		+	const c8* Title; // Title of the page (NULL means no title)
		+	MenuItem* Items; // List of the page's menu entries
		+	u8 ItemNum; // Number of the page's menu entries
		+	callback Callback; // Function to be called when page is opened
		+	} Menu;
		+
		+	A page is generally composed of a list of entries, and a menu is composed of a list of pages.

	== Annexe ==		== Annexe ==