EventMenuText

Called when the engine is about to display the menu items for an event. This Hook is defined for most event types that display a menu. However, it has been tested for very few.

Parameters

No parameters.

Context

No Context

Return Value

The value returned by this Hook is a string that names the menu items to be changed and the text that should be used in their place. The value is a 'delimited string'. Each substring defines the replacement for a single menu item. Each such substring is itself a 'delimited string' containing three substrings:

1. The original menu item text

2. The new menu item text

3. The index of the keyboard shortcut for that menu item

Example of use

The Tavern event normally displays the options “Drink”, “Fight”, “Listen”, and “Exit”. Here is how we would change the “Drink” to “Order” and the “Listen” to “Observe”.

We need two substrings: One for “Drink” and one for “Listen”. The delimited strings can use any characters you choose as delimiters. We will use the slash character ('/'). Here are the two substrings:

/Drink/Order/0

/Listen/Observe/1

This will cause “Order” to replace “Drink” and the keyboard shortcut will be the 'zeroth' character of “Order”, or 'O'. “Observe” will replace “Listen” and the shortcut character will be 'b'.

The final result that the Hook should return (arbitrarily using dollar sign as delimiter):

$/Drink/Order/0$/Listen/Observe/1