Menu API (SourceMod) - Revision history

Kleiner at 13:35, 20 July 2021

2021-07-20T13:35:23Z

2020-03-30T00:49:15Z

Update formatting for readability and consistency

2020-03-29T23:52:32Z

Update highlighting

2018-10-30T21:56:40Z

Other minor code fixes

2018-10-30T21:54:13Z

‎Basic Panel: "intargs" > "int args"

2018-10-02T10:56:01Z

‎Translations: formatting for consistency

2018-10-02T10:54:05Z

‎Simple Vote: formatting for consistency

2018-10-02T10:52:36Z

‎Basic Paginated Menu: redundant code that the delete function already does.

2018-10-02T10:48:08Z

‎Basic Panel: Formatting for consistency

2017-01-04T21:31:11Z

Changed INVALID_HANDLE to null (1.7)

← Older revision		Revision as of 13:35, 20 July 2021
Line 1:		Line 1:
		+	{{Languages\|Menu API (SourceMod)}}
	SourceMod has an extensive API for building and displaying menus to clients. Unlike AMX Mod X, this API is highly state driven. Menus are based on callbacks which are guaranteed to be fired.		SourceMod has an extensive API for building and displaying menus to clients. Unlike AMX Mod X, this API is highly state driven. Menus are based on callbacks which are guaranteed to be fired.

@@ Line 253: / Line 253: @@
 		/* Cut off the name at any whitespace */
 		int len = strlen(mapname);
-		for (int i=0; i<len; i++)
+		for (int i = 0; i < len; i++)
+		{
 			if (IsCharSpace(mapname[i]))
@@ Line 340: / Line 340: @@
 ==Simple Vote==
-<pawn>public int Handle_VoteMenu(Menu menu, MenuAction action, int param1,int param2)
+<pawn>public int Handle_VoteMenu(Menu menu, MenuAction action, int param1, int param2)
+{
 	if (action == MenuAction_End)

@@ Line 187: / Line 187: @@
+}
-public Action Panel_Test1(int client, intargs)
+public Action Panel_Test1(int client, int args)
+{
 	Panel panel = new Panel();

@@ Line 440: / Line 440: @@
 		/* This is called after VoteEnd */
 		delete menu;
 	} else if (action == MenuAction_VoteEnd) {
 		/* 0=yes, 1=no */
 		if (param1 == 0)
@@ Line 448: / Line 450: @@
 			ServerCommand("changelevel %s", map);
+		}
 	} else if (action == MenuAction_DisplayItem) {
 		/* Get the display string, we'll use it as a translation phrase */
 		char display[64];
@@ Line 459: / Line 463: @@
 		/* Override the text */
 		return RedrawMenuItem(buffer);
 	} else if (action == MenuAction_Display) {
 		/* Panel Handle is the second parameter */
 		Panel panel = view_as<Panel>(param2);

@@ Line 346: / Line 346: @@
 		/* This is called after VoteEnd */
 		delete menu;
 	} else if (action == MenuAction_VoteEnd) {
 		/* 0=yes, 1=no */
 		if (param1 == 0)

@@ Line 230: / Line 230: @@
 public void OnMapEnd()
+{
-	if (g_MapMenu != null)
+	delete g_MapMenu;
+}

@@ Line 180: / Line 180: @@
+	{
 		PrintToConsole(param1, "You selected item: %d", param2);
 	} else if (action == MenuAction_Cancel) {
 		PrintToServer("Client %d's menu was cancelled.  Reason: %d", param1, param2);
+	}

@@ Line 91: / Line 91: @@
 ==Panels==
-For panels, the callback rules change.  Panels only receive two of the above callbacks, and it is guaranteed that only one of them will be called for a given display cycle.  For C++, the <tt>IBaseMenu</tt> pointer will always be <tt>NULL</tt>.  For SourcePawn, the menu Handle will always be <tt>INVALID_HANDLE</tt>.
+For panels, the callback rules change.  Panels only receive two of the above callbacks, and it is guaranteed that only one of them will be called for a given display cycle.  For C++, the <tt>IBaseMenu</tt> pointer will always be <tt>NULL</tt>.  For SourcePawn, the menu Handle will always be <tt>INVALID_HANDLE</tt> or <tt>null</tt>.
 *'''Select'''.  A key has been pressed.  This can be any number and should not be considered as reliably in bounds.  For example, even if you only had 2 items in your panel, a client could trigger a key press of "43."
@@ Line 228: / Line 228: @@
 public void OnMapEnd()
+{
-	if (g_MapMenu != INVALID_HANDLE)
+	if (g_MapMenu != null)
+	{
 		delete(g_MapMenu);