Skip to main content

Dialogue Buttons

Dialogue Buttons are used to provide interactive components which can display dialogue options to the player. They provide functionality to change the color of the button's text and an image component based on the state of a button, such as when it is hovered over or pressed.

Button Settings

Text Settings

Dialogue Button Text Settings
SettingDescription
TextThe Text component which will be used to display the button text.
Text Mesh Pro TextIf TextMeshPro is enabled, this should be the TextMeshPro component which will be used to display the button text.
Normal Text ColorThe color to use on the button text when in 'normal' mode.
Highlighted Text ColorThe color to use on the button text when in 'highlighted' mode.
Pressed Text ColorThe color to use on the button text when in 'pressed' mode.
Disabled Text ColorThe color to use on the button text when in 'disabled' mode.

Image Settings

Dialogue Button Image Settings
SettingDescription
Background ImageThe image component of the button which will have its color updated whenever the state of the button changes.
Normal Button ColorThe color to use on the button image when in 'normal' mode.
Highlighted Button ColorThe color to use on the button image when in 'highlighted' mode.
Pressed Button ColorThe color to use on the button image when in 'pressed' mode.
Disabled Button ColorThe color to use on the button image when in 'disabled' mode.
tip

If you want to use multiple Images in a Dialogue Button, you can add as many as you want, but the Dialogue Button only supports changing the color of 1 button, so make sure you set the Background Image setting to the right Image.

Audio Settings

Dialogue Button Audio Settings
SettingDescription
Audio SourceThe Audio Source to use for playing button interaction sounds.
Hover SoundThe Audio Clip to play when the button is highlighted/selected/hovered.

Events

Event NameDescription
On ClickCalled whenever the player clicks on the button.
On EnterCalled whenever the mouse moves over the button.
On LeaveCalled whenever the mouse leaves the button.
On PressCalled whenever the player presses the mouse over the button.
On NormalCalled whenever the button goes into 'normal' mode.
On HighlightedCalled whenever the button goes into 'highlighted' mode.