User Tools

Site Tools


scripting:reference:scriptingmainui

This is an old revision of the document!


Scripting Main UI

Most of the elements on the main UI (e.g. the ESC menu, time/status displays and chat box) are fixed or configurable primarily through settings.

Main UI settings

FIXME: (Link to some of the main settings controls).

Notification messages

FIXME: (Link to instructions for setting up notification messages)

ScriptedOption command

Some UI elements can optionally be scripted through the *scriptedoption command and the MenuOption event ( + others).

For example, you can change the buttons that appear when a player selects another in the player list to interact with, or you can add a scripted option to the ESC menu when the user presses ESC then F9 using:

*scriptedoption 1,World Tips

which when selected would trigger the event:

Event ("MenuOption", "1" )
{
  ... Insert your scripted OSD or other system here..
}

The full list of custom *scriptedoption parameters is:

1 - ESC then F9 - triggers Event( “MenuOption”, 1 )
2 - Player-player barter option replacement - triggers ?
3 - Player-player challenge option replacement - triggers ?
4 - Player-player custom option 1 (only appears if set) - triggers Event( “MenuOption”, 2 )
5 - Player-player custom option 2 (only appears if set) - triggers Event( “MenuOption”, 3 )
6 - Player-player custom option 3 (only appears if set) - triggers Event( “MenuOption”, 4 )
7 - Player-player custom option 4 (only appears if set) - triggers Event( “MenuOption”, 5 )
9 - [Unused atm]
10 - Battle system accept challenge option 1 - Triggers?
11 - Battle system accept challenge option 2 - Triggers?
12 - Battle system victor decision option 1 - Triggers?
13 - Battle system victor decision option 2 - Triggers?
14 - Battle system victor decision option 3 - Triggers?
15 - Optional extra button on towns menu, shows only for town owner - triggers Event( “TownButton”, “1” )
16 - 2nd optional extra button on towns menu, shows for all players - triggers Event( “TownButton”, “2” )
17 - 3rd optional extra button on towns menu, shows only for town owner - triggers Event( “TownButton”, “3” )
18 - Help & Info menu extra option 1 - Triggers Event( “MenuOption”, “6” )
19 - Help & Info menu extra option 2 - Triggers Event( “MenuOption”, “7” )
20 - 1st option available in the pub interface - Triggers Event( “MenuOption”, “8” )
21 - 2nd option available in the pub interface - Triggers Event( “MenuOption”, “9” )
22 - 3rd option available in the pub interface - Triggers Event( “MenuOption”, “10” )
23 - 4th option available in the pub interface - Triggers Event( “MenuOption”, “11” )
24 - 5th option available in the pub interface - Triggers Event( “MenuOption”, “12” )
25 - Additional option on netrek mode button UI - Triggers Event( “MenuOption”, “13” )
26 - Additional option on netrek mode button UI - Triggers Event( “MenuOption”, “14” )
27 - Additional option on netrek mode button UI - Triggers Event( “MenuOption”, “15” )
28 - Additional option on netrek mode button UI - Triggers Event( “MenuOption”, “16” )
29 - Additional option on netrek mode button UI - Triggers Event( “MenuOption”, “17” )
30 - Additional option on netrek mode button UI - Triggers Event( “MenuOption”, “18” )
31 - Additional option on netrek mode button UI - Triggers Event( “MenuOption”, “19” )

scripting/reference/scriptingmainui.1583794918.txt.gz · Last modified: 2020/03/09 18:01 by mit

Except where otherwise noted, content on this wiki is licensed under the following license: Public Domain
Public Domain Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki