Menus Step By Step (SourceMod Scripting) - Revision history

`666: spelling mistake

2021-08-26T07:59:43Z

spelling mistake

Sarrus: Fixed a mistake, passing MENU_TIME_FOREVER as the third argument in menu.Display throws an error.

2020-11-12T13:35:40Z

Fixed a mistake, passing MENU_TIME_FOREVER as the third argument in menu.Display throws an error.

Butare: /* MenuAction_DisplayItem */

2020-05-13T00:28:58Z

‎MenuAction_DisplayItem

Joinedsenses: Update highlighting

2020-03-29T23:53:11Z

Update highlighting

Show changes

Asherkin: Remove SetMenuTitle note, it causes confusion.

2018-12-21T18:16:40Z

Remove SetMenuTitle note, it causes confusion.

Hmmmmm: GetInfo -> GetItem

2018-10-02T00:12:32Z

GetInfo -> GetItem

NgBUCKWANGS at 10:26, 23 October 2017

2017-10-23T10:26:55Z

Mitchell: removed incorrect information

2017-01-18T16:09:39Z

removed incorrect information

Xerox8521: Updated to 1.7 Syntax

2016-06-17T12:19:02Z

Updated to 1.7 Syntax

Xerox8521: /* Step by Step */

2016-06-17T12:14:56Z

‎Step by Step

@@ Line 157: / Line 157: @@
 * MenuAction_End - Called once when all clients have closed the menu
 * MenuAction_DrawItem - Called once for each item for each user a menu is displayed to. Can change the menu item style.
-* MenuAction_DisplayIitem. - Called once for each item for each user a menu is displayed to. Can change the menu item text.
+* MenuAction_DisplayItem. - Called once for each item for each user a menu is displayed to. Can change the menu item text.
 These will be discussed in more detail in the MenuHandler1 section.
@@ Line 238: / Line 238: @@
 The Handle argument is always the menu that called the handler.
-The MenuAction argument is always one of 7 actions for a standard menu.  They are:  MenuAction_Start, MenuAction_Display, MenuAction_Select, MenuAction_Cancel, MenuAction_End, MenuAction_DrawItem, and MenuAction_DisplayIitem.  We will discuss each of these as we reach their code.
+The MenuAction argument is always one of 7 actions for a standard menu.  They are:  MenuAction_Start, MenuAction_Display, MenuAction_Select, MenuAction_Cancel, MenuAction_End, MenuAction_DrawItem, and MenuAction_DisplayItem.  We will discuss each of these as we reach their code.
 The two cell arguments meaning depend on the MenuAction argument. '''A common mistake is to assume param1 is the client.''' This is incorrect for MenuAction_Start, MenuAction_End, MenuAction_VoteEnd, MenuAction_VoteStart, and MenuAction_VoteCancel.

@@ Line 229: / Line 229: @@
 A Menu handle, a client index, and the amount of time in seconds to show the menu.
-If you want the menu to show forever, pass MENU_TIME_FOREVER as the third argument.
+If you want the menu to show forever, pass MENU_TIME_FOREVER as the second argument.
 === MenuHandler1 ===

@@ Line 400: / Line 400: @@
 * return: return value from RedrawMenuItem or 0 for no change
-MenuAction_DrawItem is called once for each item on the menu for each user.  You can manipulate its text here. param1 is the client, param2 is the menu position.
+MenuAction_DisplayItem is called once for each item on the menu for each user.  You can manipulate its text here. param1 is the client, param2 is the menu position.
 This callback is intended for use with the Translation system.

@@ Line 273: / Line 273: @@
 MenuAction_Display is called once for each user a menu is displayed to.  param1 is the client, param2 is the MenuPanel handle.
-SetPanelTitle is used to change the menu's title based on the language of the user viewing it using the Translations system.  Previous versions of this guide suggested using SetMenuTitle.  This is a ''bad'' idea, as it changes the title globally.
+SetPanelTitle is used to change the menu's title based on the language of the user viewing it using the Translations system.
 ==== MenuAction_Select ====

@@ Line 279: / Line 279: @@
+		{
 			char info[32];
-			menu.GetInfo(param2, info, sizeof(info));
+			menu.GetItem(param2, info, sizeof(info));
 			if (StrEqual(info, CHOICE3))
+			{

@@ Line 183: / Line 183: @@
 menu.AddItem has 2 required arguments and one optional argument.
-The 3 required arguments are:
+The 2 required arguments are:
 The Info string, and the Display string.

@@ Line 177: / Line 177: @@
 <pawn>	menu.AddItem(CHOICE1, "Choice 1");
-	menu.AddItem(menu, CHOICE2, "Choice 2");
+	menu.AddItem(CHOICE2, "Choice 2");
-	menu.AddItem(menu, CHOICE3, "Choice 3");</pawn>
+	menu.AddItem(CHOICE3, "Choice 3");</pawn>
 A menu isn't useful without something in it!
@@ Line 185: / Line 185: @@
 The 3 required arguments are:
-The Menu handle, the Info string, and the Display string.
+The Info string, and the Display string.
 The Info String is a string that is used to uniquely identify this menu item.  It is never displayed to the user, but is used in various callbacks.

@@ Line 142: / Line 142: @@
 Menu_Test1 is a ConCmd, which is beyond the scope of this page.  See: [[Commands (SourceMod Scripting)|Commands]] for more details on that.  We're going to be talking about what's in it.
-==== CreateMenu ====
+==== Menu ====
 <pawn>	Menu menu = new Menu(MenuHandler1, MENU_ACTIONS_ALL);</pawn>
@@ Line 202: / Line 202: @@
 Be aware that if your CreateMenu second argument includes MenuAction_DrawItem or MENU_ACTIONS_ALL and you don't actually implement the MenuAction_DrawItem callback (or implement it and don't return the current item's style if you don't change it), your style here will be completely ignored.
-==== SetMenuExitButton ====
+==== menu.ExitButton ====
-<pawn> 	SetMenuExitButton(menu, false);</pawn>
+<pawn> 	menu.ExitButton = false;</pawn>
 Defaults to true.
@@ Line 209: / Line 209: @@
 It set to false, the menu won't have an exit button.
-==== SetMenuExitBackButton ====
+==== menu.ExitBackButton ====
-<pawn> 	SetMenuExitBackButton(menu, false);</pawn>
+<pawn> 	menu.ExitBackButton = false;</pawn>
 (This isn't in the code above, but it should be mentioned)
@@ Line 222: / Line 222: @@
 This can be used to dynamically set if a menu is being called as its own menu or as a submenu.
-==== DisplayMenu ====
+==== menu.Display ====
-<pawn> 	DisplayMenu(menu, client, 20);</pawn>
+<pawn> 	menu.Display(client, 20);</pawn>
-DisplayMenu takes 3 arguments:
+DisplayMenu takes 2 arguments:
 A Menu handle, a client index, and the amount of time in seconds to show the menu.
@@ Line 232: / Line 232: @@
 === MenuHandler1 ===
-<pawn>public MenuHandler1(Handle:menu, MenuAction:action, param1, param2)</pawn>
+<pawn>public int MenuHandler1(Menu menu, MenuAction action, int param1, int param2)</pawn>
 MenuHandler1 is a function whose signature matches the MenuHandler callback.  It can be named something other than MenuHandler1. It must always be public and it will always have these arguments: Handle, MenuAction, cell, and cell in that order.
@@ Line 259: / Line 259: @@
 <pawn>		case MenuAction_Display:
+		{
-	 		decl String:buffer[255];
+	 		char buffer[255];
 			Format(buffer, sizeof(buffer), "%T", "Vote Nextmap", param1);
-			new Handle:panel = Handle:param2;
+			Panel panel = view_as<Panel>(param2);
-			SetPanelTitle(panel, buffer);
+			panel.SetTitle(buffer);
 			PrintToServer("Client %d was sent menu with panel %x", param1, param2);
 		}</pawn>
@@ Line 278: / Line 278: @@
 <pawn>		case MenuAction_Select:
+		{
-			decl String:info[32];
+			char info[32];
-			GetMenuItem(menu, param2, info, sizeof(info));
+			menu.GetInfo(param2, info, sizeof(info));
 			if (StrEqual(info, CHOICE3))
+			{
@@ Line 325: / Line 325: @@
 <pawn>		case MenuAction_End:
+		{
-			CloseHandle(menu);
+			delete menu;
 		}</pawn>
@@ Line 348: / Line 348: @@
 <pawn>		case MenuAction_DrawItem:
+		{
-			new style;
+			int style;
-			decl String:info[32];
+			char info[32];
-			GetMenuItem(menu, param2, info, sizeof(info), style);
+			menu.GetItem(param2, info, sizeof(info), style);
 			if (StrEqual(info, CHOICE3))
@@ Line 384: / Line 384: @@
 <pawn>		case MenuAction_DisplayItem:
+		{
-			decl String:info[32];
+			char info[32];
-			GetMenuItem(menu, param2, info, sizeof(info));
+			menu.GetItem(param2, info, sizeof(info));
-			decl String:display[64];
+			char display[64];
 			if (StrEqual(info, CHOICE3))

@@ Line 144: / Line 144: @@
 ==== CreateMenu ====
-<pawn>	new Handle:menu = CreateMenu(MenuHandler1, MENU_ACTIONS_ALL);</pawn>
+<pawn>	Menu menu = new Menu(MenuHandler1, MENU_ACTIONS_ALL);</pawn>
-CreateMenu takes two arguments.
+Menu takes two arguments.
-The first is a function that matches the [http://docs.sourcemod.net/api/index.php?fastload=show&id=768& MenuHandler] callback signature.
+The first is a function that matches the [https://sm.alliedmods.net/new-api/menus/MenuHandler MenuHandler] callback signature.
 The second is a bitmask of which MenuAction events we are going to handle in our MenuHandler.  There are 7 that apply to standard menus:
@@ Line 167: / Line 167: @@
 To specify just a few of them, you can do this:
-<pawn>	new Handle:menu = CreateMenu(MenuHandler1, MenuAction_Start|MenuAction_Select|MenuAction_Cancel|MenuAction_End);</pawn>
+<pawn>	Menu menu = new Menu(MenuHandler1, MenuAction_Start|MenuAction_Select|MenuAction_Cancel|MenuAction_End);</pawn>
-==== SetMenuTitle ====
+==== menu.SetTitle ====
-<pawn>	SetMenuTitle(menu, "%T", "Menu Title", LANG_SERVER);</pawn>
+<pawn>	menu.SetTitle("%T", "Menu Title", LANG_SERVER);</pawn>
 Sets the menu's title.  This example uses the translation system and the server's default language.  This isn't strictly necessary as we will set the menu title again later.
-==== AddMenuItem ====
+==== menu.AddItem ====
-<pawn>	AddMenuItem(menu, CHOICE1, "Choice 1");
+<pawn>	menu.AddItem(CHOICE1, "Choice 1");
-	AddMenuItem(menu, CHOICE2, "Choice 2");
+	menu.AddItem(menu, CHOICE2, "Choice 2");
-	AddMenuItem(menu, CHOICE3, "Choice 3");</pawn>
+	menu.AddItem(menu, CHOICE3, "Choice 3");</pawn>
 A menu isn't useful without something in it!
-AddMenuItem has 3 required arguments and one optional argument.
+menu.AddItem has 2 required arguments and one optional argument.
 The 3 required arguments are: