MENU - Revision history

MrSugarCube at 22:44, 9 June 2009

2009-06-09T22:44:52Z

MrSugarCube at 22:39, 9 June 2009

2009-06-09T22:39:54Z

MrSugarCube at 22:36, 9 June 2009

2009-06-09T22:36:06Z

MrSugarCube: Created page with 'FORCETOC Menus are a simple way of displaying a selection dialog to clients. Menus can be shown to players in one of two styles: * Text-based * Item-based ==Text-Based Menu...'

2009-06-09T22:19:05Z

Created page with '__FORCETOC__ Menus are a simple way of displaying a selection dialog to clients. Menus can be shown to players in one of two styles: * Text-based * Item-based ==Text-Based Menu...'

New page

__FORCETOC__
Menus are a simple way of displaying a selection dialog to clients. Menus can be shown to players in one of two styles:
* Text-based
* Item-based

==Text-Based Menu==
The syntax for defining a text-based menu is as follows:

<tt>
[MENU ''defname''] 
''title'' 
 
ON=0 ''text'' 
    ''script'' 
 
ON=0 ''text'' 
    ''script'' 
 
</tt>

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| ''defname'' || The menu's defname.
|-
| ''title'' || The title of the menu. Properties and references of the object the menu was called on can be accessed.
|-
| ''text'' || The text to display for the option. Properties and references of the object the menu was called on can be accessed.
|-
| ''script'' || The script to run when the option is pressed.
|}

==Item-Based Menu==
The syntax for an item-based menu is as follows:

<tt>
[MENU ''defname''] 
''title'' 
 
ON=''baseid'' ''text'' 
    ''script'' 
 
ON=''baseid'' @''hue'', ''text'' 
    ''script'' 
 
</tt>

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| ''defname'' || The menu's defname.
|-
| ''title'' || The title of the menu. Properties and references of the object the menu was called on can be accessed.
|-
| ''baseid'' || The item [[BASEID]] to display for the button.
|-
| ''hue'' || If the @''hue'' syntax is used, the item will be displayed in the specified colour.
|-
| ''text'' || The text to display for the option. Properties of the ITEMDEF that ''baseid'' refers to can be accessed.
|-
| ''script'' || The script to run when the button is pressed.
|-
|}

==Examples==

<spherescript>
//
// Displays a menu asking if the player wants more gold, and creates it
// if they select Yes.
//
[MENU m_goldmenu]
You currently have <SRC.BANKBALANCE>gp in your account. Would you like some more gold?

ON=0 Yes
SERV.NEWITEM i_gold, 5000
SRC.BOUNCE <NEW.UID>
RETURN

ON=0 No
SRC.SYSMESSAGE Ok then!
RETURN
</spherescript>

<spherescript>
//
// Displays a menu asking the player which item they would like.
//
[MENU m_itemmenu]
Which item would you like?

ON=i_sword_viking <NAME>
SERV.NEWITEM i_sword_viking
SRC.BOUNCE <NEW.UID>
RETURN

ON=i_gold 5000 <NAME>
SERV.NEWITEM i_gold, 5000
SRC.BOUNCE <NEW.UID>
RETURN

ON=i_backpack @020, a red backpack
SERV.NEWITEM i_backpack
NEW.COLOR = 020
SRC.BOUNCE <NEW.UID>
RETURN

ON=0 Nothing
SRC.SYSMESSAGE You get nothing!
RETURN

</spherescript>

← Older revision		Revision as of 22:39, 9 June 2009
Line 138:		Line 138:

	</spherescript>		</spherescript>
		+
		+	[[Category: Reference Compendium]]
		+	[[Category: Definitions]]

@@ Line 135: / Line 135: @@
 ON=0 Nothing
 	SRC.SYSMESSAGE You get nothing!
 	RETURN

@@ Line 6: / Line 6: @@
 ==Text-Based Menu==
 The syntax for defining a text-based menu is as follows:
@@ Line 67: / Line 69: @@
 |-
 |}

MENU - Revision history

MrSugarCube at 22:44, 9 June 2009

MrSugarCube at 22:39, 9 June 2009

MrSugarCube at 22:36, 9 June 2009

MrSugarCube: Created page with '__FORCETOC__ Menus are a simple way of displaying a selection dialog to clients. Menus can be shown to players in one of two styles: * Text-based * Item-based ==Text-Based Menu...'

MrSugarCube: Created page with 'FORCETOC Menus are a simple way of displaying a selection dialog to clients. Menus can be shown to players in one of two styles: * Text-based * Item-based ==Text-Based Menu...'