Menu API - Revision history

F at 22:07, 9 July 2011

2011-07-09T22:07:47Z

← Older revision		Revision as of 22:07, 9 July 2011
Line 16:		Line 16:
	===Notification===		===Notification===
	[[Image:NoticeConcept.png\|frame\|Notice concept]][[Image:NoticeConceptFallback.png\|frame\|Notice fallback]]		[[Image:NoticeConcept.png\|frame\|Notice concept]][[Image:NoticeConceptFallback.png\|frame\|Notice fallback]]
	Simple plain-text message with a "close" button. Usable for showing server rules, world descriptions, global notifications, etc - any kind of information that the user just needs to read through and close~~. The client still needs to notify the client when the menu is closed, but it can hide the notification right away~~.		Simple plain-text message with a "close" button. Usable for showing server rules, world descriptions, global notifications, etc - any kind of information that the user just needs to read through and close.
	* byte '''OpCode'''		* byte '''OpCode'''
	* string '''Message'''		* string '''Message'''
	* string '''CloseButtonLabel'''		* string '''CloseButtonLabel'''
			* bool '''CloseOnSelection''' - If enabled, client may close the menu immediately after selection. Otherwise, it should wait for CloseMenu packet.

	<br style="clear:both" />		<br style="clear:both" />

	===MenuYesNo===		===MenuYesNo===
	[[Image:VoteConcept.png\|frame\|Vote dialog concept]][[Image:VoteConceptFallback.png\|frame\|Vote dialog fallback]]		[[Image:VoteConcept.png\|frame\|Vote dialog concept]][[Image:VoteConceptFallback.png\|frame\|Vote dialog fallback]]
	A plain-text message with two buttons - one for "Yes", and one for "No". Can be used for votes or confirmation prompts.		A plain-text message with two buttons - one for "Yes", and one for "No". Can be used for votes or confirmation prompts. No close button is shown.
	* byte '''OpCode'''		* byte '''OpCode'''
	* string '''Message'''		* string '''Message''' - Label to be shown above the two options. Not selectable.
	* string '''YesButtonLabel'''		* string '''YesButtonLabel''' - Option 1
	* string '''NoButtonLabel'''		* string '''NoButtonLabel''' - Option 2
	* ~~byte~~ '''~~SelectedIndex~~'''		* bool '''CloseOnSelection''' - If enabled, client may close the menu immediately after selection. Otherwise, it should wait for CloseMenu packet.

	<br style="clear:both" />		<br style="clear:both" />
Line 42:		Line 42:
	** string '''MenuItemLabel'''		** string '''MenuItemLabel'''
	* string '''CloseButtonLabel'''		* string '''CloseButtonLabel'''
	* ~~byte~~ '''~~SelectedIndex~~'''		* bool '''CloseOnSelection''' - If enabled, client may close the menu immediately after selection. Otherwise, it should wait for CloseMenu packet.

	===MenuClose===		===MenuClose===
	Forces any open menu to close. ~~Client~~ is ~~still required to send a MenuClosed event~~, ~~with a special ButtonIndex code (see above)~~.		Forces any open menu to close. No reply is expected from the client. If no menu is currently open, client can ignore this.
	* byte '''OpCode'''		* byte '''OpCode'''

F: /* Notification */

2011-07-09T04:14:16Z

Notification

← Older revision		Revision as of 04:14, 9 July 2011
Line 16:		Line 16:
	===Notification===		===Notification===
	[[Image:NoticeConcept.png\|frame\|Notice concept]][[Image:NoticeConceptFallback.png\|frame\|Notice fallback]]		[[Image:NoticeConcept.png\|frame\|Notice concept]][[Image:NoticeConceptFallback.png\|frame\|Notice fallback]]
	Simple plain-text message with a "close" button. Usable for showing server rules, world descriptions, global notifications, etc - any kind of information that the user just needs to read through and close.		Simple plain-text message with a "close" button. Usable for showing server rules, world descriptions, global notifications, etc - any kind of information that the user just needs to read through and close. The client still needs to notify the client when the menu is closed, but it can hide the notification right away.
	* byte '''OpCode'''		* byte '''OpCode'''
	* string '''Message'''		* string '''Message'''
Line 22:		Line 22:

	<br style="clear:both" />		<br style="clear:both" />

	===MenuYesNo===		===MenuYesNo===
	[[Image:VoteConcept.png\|frame\|Vote dialog concept]][[Image:VoteConceptFallback.png\|frame\|Vote dialog fallback]]		[[Image:VoteConcept.png\|frame\|Vote dialog concept]][[Image:VoteConceptFallback.png\|frame\|Vote dialog fallback]]

F: /* Menu */

2011-07-09T04:11:29Z

← Older revision		Revision as of 04:11, 9 July 2011
Line 36:		Line 36:
	Fully-featured way to construct menus. Allows customizing each line if the menu.		Fully-featured way to construct menus. Allows customizing each line if the menu.
	* byte '''OpCode'''		* byte '''OpCode'''
	* ~~vstring~~ '''Message'''		* string '''Message'''
	* byte '''MenuItemCount'''		* byte '''MenuItemCount'''
	** byte '''MenuItemType'''		** byte '''MenuItemType'''

F: /* Packets (Client -> Server) */

2011-07-09T04:11:10Z

Packets (Client -> Server)

← Older revision		Revision as of 04:11, 9 July 2011
Line 48:		Line 48:

	=Packets (Client -> Server)=		=Packets (Client -> Server)=
	===~~MenuItemClicked~~===		===MenuItemSelected===
	* byte '''OpCode'''		* byte '''OpCode'''
	* sbyte '''ButtonIndex'''		* sbyte '''ButtonIndex'''

	[[Category:Protocol Extensions]]		[[Category:Protocol Extensions]]

F: /* Packets (Client -> Server) */

2011-07-09T04:11:00Z

Packets (Client -> Server)

← Older revision		Revision as of 04:11, 9 July 2011
Line 48:		Line 48:

	=Packets (Client -> Server)=		=Packets (Client -> Server)=
	===~~MenuClosed~~===		===MenuItemClicked===
	* byte '''OpCode'''		* byte '''OpCode'''
	* sbyte '''ButtonIndex'''		* sbyte '''ButtonIndex'''

	[[Category:Protocol Extensions]]		[[Category:Protocol Extensions]]

F at 04:02, 9 July 2011

2011-07-09T04:02:41Z

← Older revision		Revision as of 04:02, 9 July 2011
Line 52:		Line 52:
	* sbyte '''ButtonIndex'''		* sbyte '''ButtonIndex'''

	{{Category:Protocol Extensions}}		[[Category:Protocol Extensions]]

F: moved FClient/Menu API to Menu API

2011-07-09T04:01:29Z

moved FClient/Menu API to Menu API

← Older revision		Revision as of 04:01, 9 July 2011
(No difference)

F at 03:59, 9 July 2011

2011-07-09T03:59:23Z

← Older revision		Revision as of 03:59, 9 July 2011
Line 51:		Line 51:
	* byte '''OpCode'''		* byte '''OpCode'''
	* sbyte '''ButtonIndex'''		* sbyte '''ButtonIndex'''

			{{Category:Protocol Extensions}}

F: Created page with "Influenced by SourceMod menu, allows to display menus, votes, options, confirmation prompts, alerts, and other interactive dialogs/menus. =MenuItemType enumeration= # '''Spacer'..."

2011-07-09T03:53:19Z

Created page with "Influenced by SourceMod menu, allows to display menus, votes, options, confirmation prompts, alerts, and other interactive dialogs/menus. =MenuItemType enumeration= # '''Spacer'..."

New page

Influenced by SourceMod menu, allows to display menus, votes, options, confirmation prompts, alerts, and other interactive dialogs/menus.

=MenuItemType enumeration=
# '''Spacer''' = empty space
# '''PlainText''' = plain white text (cannot be selected)
# '''Button''' = button that can be selected
# '''DisabledButton''' = grayed-out button that cannot be selected

=Button Index Codes=
: '''-2''' = Menu was closed by MenuClose packet
: '''-1''' = Menu was closed by user hitting Escape
: '''0''' = Last button (bottom-most)
: '''1, 2, 3..''' = Other buttons, starting with the top button.

=Packets (Server -> Client)=
===Notification===
[[Image:NoticeConcept.png|frame|Notice concept]][[Image:NoticeConceptFallback.png|frame|Notice fallback]]
Simple plain-text message with a "close" button. Usable for showing server rules, world descriptions, global notifications, etc - any kind of information that the user just needs to read through and close.
* byte '''OpCode'''
* string '''Message'''
* string '''CloseButtonLabel'''

<br style="clear:both" />
===MenuYesNo===
[[Image:VoteConcept.png|frame|Vote dialog concept]][[Image:VoteConceptFallback.png|frame|Vote dialog fallback]]
A plain-text message with two buttons - one for "Yes", and one for "No". Can be used for votes or confirmation prompts.
* byte '''OpCode'''
* string '''Message'''
* string '''YesButtonLabel'''
* string '''NoButtonLabel'''
* byte '''SelectedIndex'''

<br style="clear:both" />
===Menu===
[[Image:ComplexMenuConcept.png|frame|Complex menu concept]]
Fully-featured way to construct menus. Allows customizing each line if the menu.
* byte '''OpCode'''
* vstring '''Message'''
* byte '''MenuItemCount'''
** byte '''MenuItemType'''
** string '''MenuItemLabel'''
* string '''CloseButtonLabel'''
* byte '''SelectedIndex'''

===MenuClose===
Forces any open menu to close. Client is still required to send a MenuClosed event, with a special ButtonIndex code (see above).
* byte '''OpCode'''

=Packets (Client -> Server)=
===MenuClosed===
* byte '''OpCode'''
* sbyte '''ButtonIndex'''