small clarification to param2 in MenuAction_End
authorDavid Anderson <dvander@alliedmods.net>
Sun Nov 25 18:50:13 2007 +0000 (2007-11-25)
changeset 1725ea875bcbc286
parent 1724 d9c2d3a9aaa1
child 1726 5ca491ac0e35
small clarification to param2 in MenuAction_End
plugins/include/menus.inc
     1.1 --- a/plugins/include/menus.inc	Sun Nov 25 18:06:49 2007 +0000
     1.2 +++ b/plugins/include/menus.inc	Sun Nov 25 18:50:13 2007 +0000
     1.3 @@ -54,7 +54,10 @@
     1.4  	MenuAction_Display = (1<<1),	/**< A menu is about to be displayed (param1=client, param2=MenuPanel Handle) */
     1.5  	MenuAction_Select = (1<<2),		/**< An item was selected (param1=client, param2=item) */
     1.6  	MenuAction_Cancel = (1<<3),		/**< The menu was cancelled (param1=client, param2=reason) */
     1.7 -	MenuAction_End = (1<<4),		/**< A menu display has fully ended (param1=reason, param2=cancel reason) */
     1.8 +	MenuAction_End = (1<<4),		/**< A menu display has fully ended.
     1.9 +										 param1 is the MenuEnd reason, and if it's MenuEnd_Cancelled, then 
    1.10 +										 param2 is the MenuCancel reason from MenuAction_Cancel.
    1.11 +										 */
    1.12  	MenuAction_VoteEnd = (1<<5),	/**< (VOTE ONLY): A vote sequence has succeeded (param1=chosen item) 
    1.13  										 This is not called if SetVoteResultCallback has been used on the menu. */
    1.14  	MenuAction_VoteStart = (1<<6), 	/**< (VOTE ONLY): A vote sequence has started (nothing passed) */