Message Box
Message Box¶
Message Box types display text to the player.
Note: For example, character dialogue, narration, or informing the player about an action.
Properties¶
System¶
| Name | Explanation | Type |
|---|---|---|
| Body Border Element | The element that wraps the body content. | User Interface Element |
| Body Element | The element that hosts the body content. | User Interface Element |
| Collate Messages | Whether or not to maintain the same message box between displaying messages. | Toggle |
| Header Border Element | The element that wraps the header content. | User Interface Element |
| Header Element | The element that hosts the header content. | User Interface Element |
| Pagination Strategy | The method of displaying more text when space runs out. | Text Pagination Strategy |
| Pause Gameplay | Whether or not to pause gameplay from continuing while the message box is open. | Toggle |
| Portrait Element | The element that hosts the portrait. | User Interface Element |
| Prompt Element | The element that displays when a message is finished displaying. | User Interface Element |
| Shrink Body | Whether or not to fit the body border to the body content. | Toggle |
| Shrink Header | Whether or not to fit the header border to the header content. | Toggle |
| Tail Bottom Element | The picture element displayed as a tail pointing downward toward the target. | User Interface Element |
| Tail Left Element | The picture element displayed as a tail pointing left toward the target. | User Interface Element |
| Tail Right Element | The picture element displayed as a tail pointing right toward the target. | User Interface Element |
| Tail Top Element | The picture element displayed as a tail pointing upward toward the target. | User Interface Element |
| Vertical Pagination Speed | The vertical speed to use when paginating. | Number |
Text Pagination Strategy¶
| Name | Explanation |
|---|---|
| Clear Text | The text is completely cleared and the next set of lines is displayed. |
| Retain Line | The text scrolls up one line at a time, requiring confirmation to continue. |
| Retain Paragraph | The text scrolls up a full paragraph at a time, requiring confirmation to continue. |