scripting:reference:scriptingmainui
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| scripting:reference:scriptingmainui [2020/03/08 16:01] – mit | scripting:reference:scriptingmainui [2023/09/14 08:43] (current) – [ScriptedOption command] mit | ||
|---|---|---|---|
| Line 3: | Line 3: | ||
| 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. | 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). | FIXME: (Link to some of the main settings controls). | ||
| - | Some UI elements can optionally be scripted through **MenuOption** event and the ***scriptedoption** command. | + | ==== Notification messages ==== |
| - | 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: | + | The notification system provides a list of messages that are shown to the user on the left side of the screen. The messages disappear after a defined time (a few seconds by default but they can be made to last longer), and if multiple messages are triggered they are queued up, giving the player a few seconds to read each one. |
| + | |||
| + | Notification messages can be automated, generated by command or made using scripted OSD. See [[world_Setup: | ||
| + | |||
| + | ==== Main On-screen Message ==== | ||
| + | |||
| + | You can use the commands: | ||
| + | ***setmainscore [PLAYER_NAME], | ||
| + | ***setmainmsg [PLAYER_NAME], | ||
| + | .. to set a message which is permanently displayed at the top left of the player' | ||
| + | |||
| + | ==== ScriptedOption command ===== | ||
| + | |||
| + | Some UI elements can optionally be scripted by activation with 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 (scriptedoptions 2-6), or you can add a scripted option to the ESC menu when the user presses ESC then F9 using: | ||
| < | < | ||
| which when selected would trigger the event: | which when selected would trigger the event: | ||
| Line 20: | Line 36: | ||
| 1 - ESC then F9 - triggers Event( " | 1 - ESC then F9 - triggers Event( " | ||
| - | 2 - Player-player barter option replacement | + | 2 - Player-player barter option replacement |
| - | 3 - Player-player challenge option replacement - triggers | + | 3 - Player-player challenge option replacement - triggers |
| - | 4 - Player-player custom option 1 (only appears if set) - triggers Event( " | + | 4 - Player-player custom option 1 (only appears if set) - triggers |
| - | 5 - Player-player custom option 2 (only appears if set) - triggers Event( " | + | 5 - Player-player custom option 2 (only appears if set) - triggers |
| - | 6 - Player-player custom option 3 (only appears if set) - triggers Event( " | + | 6 - Player-player custom option 3 (only appears if set) - triggers |
| - | 7 - Player-player custom option 4 (only appears if set) - triggers Event( " | + | 7 - Player-player custom option 4 (only appears if set) - triggers |
| 9 - [Unused atm]\\ | 9 - [Unused atm]\\ | ||
| - | 10 - Battle system accept challenge option 1 - *scriptedoption 10, | + | 10 - Battle system accept challenge option 1 - Triggers?\\ |
| - | 11 - Battle system accept challenge option 2 - *scriptedoption 11, | + | 11 - Battle system accept challenge option 2 - Triggers?\\ |
| - | 12 - Battle system victor decision option 1 - *scriptedoption 12, | + | 12 - Battle system victor decision option 1 - Triggers?\\ |
| - | 13 - Battle system victor decision option 2 - *scriptedoption 13, | + | 13 - Battle system victor decision option 2 - Triggers?\\ |
| - | 14 - Battle system victor decision option 3 - *scriptedoption 14, | + | 14 - Battle system victor decision option 3 - Triggers?\\ |
| - | 15 - Optional extra button on towns menu, shows only for town owner - triggers Event( " | + | 15 - Optional extra button on towns menu, shows only for town owner - triggers |
| - | 16 - 2nd optional extra button on towns menu, shows for all players - triggers Event( " | + | 16 - 2nd optional extra button on towns menu, shows for all players - triggers |
| - | 17 - 3rd optional extra button on towns menu, shows only for town owner - triggers Event( " | + | 17 - 3rd optional extra button on towns menu, shows only for town owner - triggers |
| - | 18 - Help & Info menu extra option 1 - Triggers Event( " | + | 18 - Help & Info menu extra option 1 - Triggers |
| - | 19 - Help & Info menu extra option 2 - Triggers Event( " | + | 19 - Help & Info menu extra option 2 - Triggers |
| - | 20 - 1st option available in the pub interface - Triggers | + | 20 - 1st option available in the pub interface - Triggers |
| - | 21 - 2nd option available in the pub interface - Triggers | + | 21 - 2nd option available in the pub interface - Triggers |
| - | 22 - 3rd option available in the pub interface - Triggers | + | 22 - 3rd option available in the pub interface - Triggers |
| - | 23 - 4th option available in the pub interface - Triggers | + | 23 - 4th option available in the pub interface - Triggers |
| - | 24 - 5th option available in the pub interface - Triggers | + | 24 - 5th option available in the pub interface - Triggers |
| - | 25 - Additional | + | 25 - Additional netrek mode button: ? icon when not in orbit - Triggers |
| - | 26 - Additional | + | 26 - Additional netrek mode button: $ icon when not in orbit - Triggers |
| - | 27 - Additional | + | 27 - Additional netrek mode button: i icon when not in orbit - Triggers |
| - | 28 - Additional | + | 28 - Additional netrek mode button: arrow icon replaces refuel option when in orbit - Triggers |
| - | 29 - Additional | + | 29 - Additional netrek mode button: ? icon when in orbit - Triggers |
| - | 30 - Additional | + | 30 - Additional netrek mode button: $ icon when in orbit - Triggers |
| + | 31 - Additional netrek mode button: i icon when in orbit - Triggers **Event( " | ||
| + | 32 - Customises the standard building interface 'Extra Info' option. - Triggers **Event( " | ||
| + | 33 - Additonal button on the building stockroom interface - Triggers **Event( " | ||
scripting/reference/scriptingmainui.1583701296.txt.gz · Last modified: 2020/03/08 16:01 by mit