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

NameExplanationType
Background ElementThe background border to use for the dialogue.User Interface Element
Background ElementThe list to populate with Options for the dialogue.User Interface Element
Shrink HorizontallyWhether or not to shrink the containers to fit the width of the contents.Toggle
Shrink VerticallyWhether or not to shrink the containers to fit the height of the contents.Toggle
Pause GameplayWhether 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

NameExplanationType
Is CancelableWhether 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 GameplayWhether or not to prevent the gameplay from continuing while the menu is active.Toggle
Render SceneWhether or not to continue rendering the current scene in the background.Toggle
ContextThe data to populate in the User Interface Elements.User Interface Context?
FiltersThe 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

NameExplanationType
Header ElementThe text element to push Header content into, when displaying a message.User Interface Element
Body ElementThe text element to push the Body content into, when displaying a message.User Interface Element
Picture ElementThe picture element to push the Portrait content into, when displaying a message.User Interface Element
Pagination StrategyThe 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

NameExplanationType
ContextThe data to populate in the User Interface Elements.User Interface Context?
FiltersThe 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

NameExplanationType
Is CancelableWhether 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 GameplayWhether or not to prevent the gameplay from continuing while the shopis active.Toggle
Render SceneWhether or not to continue rendering the current scene in the background.Toggle