...
Generic Custom Input Event
start - Sent at
| Event | Sent When | Return | Value Data | Extra Info |
|---|---|---|---|---|
| start | At the start of the input system |
...
| One of the |
...
| Input Arrays to open the next/first input | This is the value sent when starting the menu, ie from the script command | |
| finished |
...
Custom Menu Events
Some additional events will be used when using a custom menu
Agent Command Events
...
| Sent when the input has finished and closed | Allows for cleanup, ie removing global/local variables used | |||
| arguments | After the last input has returned | Array of arguments to pass to caller | If using from ship/agent command, the arguments are sent to the command script, otherwise the array is returned to the calling command | |
| cancelled | After any input is closed without selection | New Input array or null | The ID of the cancelled input | |
| closed | After the menu is forced closed externally | NOTE: this is rarely used | ||
| returned | After an "next" input menu has closed | an Input Array to open new or update previous menu | Array:
| This returns when a menu opened via "nextinput" is closed. This allows you to get the return value, and update the current menu |
| cmdcheck | before first input is open | CmdCheck constants | This is used to check if the command should be disabled/enabled. Ignored if not used with ship/agent command | |
| isdisabled | when parent menu is opened | BOOLEAN | ID of context menu item | Used for menus added to context menus/sidebar. Also used for diplomacy tasks |
| ishidden | When parent menu is opened | BOOLEAN | ID of context menu item | Used for menus added to context menus/siderbar. Can hide the command if needed |
Custom Menu Events
Some additional events will be used when using a custom menu
| Event | Start When | Return | Value Data | Extra Info |
|---|---|---|---|---|
| select | ||||
| switch | ||||
| selection | ||||
| escapepressed | ||||
| contextmenu | ||||
| contextmenu_update | ||||
| hotkey | ||||
| search | ||||
| group | ||||
| tradebar | ||||
| tradebar_changed | ||||
| update | ||||
| tabchanged | ||||
| heading_click | ||||
| tradebar_full | ||||
| tradebar_empty | ||||
| hyperlink |
Agent Command Events
When using a menu script with agent commands, some additional events are used to control the Diplomacy UI
| Event | Start When | Return | Value Data | Extra Info |
|---|---|---|---|---|
| allowmultiple | ||||
| influence | ||||
| isspy | ||||
| upkeep | ||||
| data |