User Interface Types
Introduction
User interface types are representative of the overall behavior of a User Interface.
Types
Dialogue
Dialogue is used to assemble a set of responses, much like a menu. Dialogue will use the first contextual User Interface Element and populate it with the provided dialogue choices.
Supported Elements:
- List
- Directional List
Properties
| Name | Explanation | Type |
|---|---|---|
| Background Element | The background border to use for the dialogue. | User Interface Element |
| Options Element | The list to populate with Options for the dialogue. | User Interface Element |
| Shrink Horizontally | Whether or not to shrink the containers to fit the width of the contents. | Toggle |
| Shrink Vertically | Whether or not to shrink the containers to fit the height of the contents. | Toggle |
| Pause Gameplay | Whether or not to prevent the gameplay from continuing while the dialogue is active. | Toggle |
Menu
Menu is used to assemble any menu, such as a pause or main menu, as well as menus in battle.
Properties
| Name | Explanation | Type |
|---|---|---|
| Is Cancelable | Whether or not the menu can be ended via the cancel button in Virtual Keys. Note: The Close Menu command can be used to escape the current menu, if used. | Toggle |
| Pause Gameplay | Whether or not to prevent the gameplay from continuing while the menu is active. | Toggle |
| Render Scene | Whether or not to continue rendering the current scene in the background. | Toggle |
| Context | The data to populate in the User Interface Element. | User Interface Context? |
| Filters | The filters that control the way the Context is filtered. | Filter? |
Message Box
Message box is used to display a message, such as a banner upon entering an area, or a dialogue between characters. See Display Static Message for an example of a command.
Properties
| Name | Explanation | Type |
|---|---|---|
| Header Element | The text element to push Header content into, when displaying a message. | User Interface Element |
| Body Element | The text element to push the Body content into, when displaying a message. | User Interface Element |
| Picture Element | The picture element to push the Portrait content into, when displaying a message. | User Interface Element |
| Collate Messages | Whether or not to maintain the same message box between messages. | Toggle |
| Pagination Strategy | The method of displaying more text when space runs out. | Pagination Strategy |
Overlay
Overlay is used to display HUD-types and other overall screen overlays.
Properties
| Name | Explanation | Type |
|---|---|---|
| Context | The data to populate in the User Interface Elements?. | User Interface Context? |
| Filters | The filters that control the way the Context is filtered. | Filter? |
Shop
Shop is used in conjunction with shop commands for shop visualization.
Note: Under the covers, a shop works much like a menu and can support the same commands, as referenced by the Is Cancelable note.
Properties
| Name | Explanation | Type |
|---|---|---|
| Is Cancelable | Whether or not the shop can be ended via the cancel button in Virtual Keys. Note: The Close Menu command can be used to escape the current shop, if used. | Toggle |
| Pause Gameplay | Whether or not to prevent the gameplay from continuing while the shopis active. | Toggle |
| Render Scene | Whether or not to continue rendering the current scene in the background. | Toggle |