Skip to main content

List Displays

listcolumn_bottomhorizontal_externalleft
listcolumn_bottomhorizontal_externalleft
listcolumn_bottomhorizontal_internalright
listcolumn_bottomhorizontal_internalright
listcolumn_leftvertical_internalbottom
listcolumn_leftvertical_internalbottom

List Displays show a list of options to the player, with either a horizontal row or vertical column of dialogue option buttons. These types of displays are usually recommended when you know that you will only have a limited number of options presented to the player at any given time, but they can also be set to Dynamic, where new option buttons will be added to the display dynamically as needed.

List Option Display Settings

List Option Display Settings

Display ID

The Display ID of the Option Display.

General Settings

SettingDescription
Force Standard Text UseWhether the Option Display should use non-TextMeshPro text components, even when TextMeshPro is installed.
Reverse ControlsIf this is true, the input controls for choosing the next/previous option will be reversed from the default setting.
Is DynamicSet this to true if you want the display to automatically create new dialogue option buttons during gameplay as needed. It will do so by cloning the first Dialogue Button in the Option Buttons List.

Font Settings

SettingDescription
Language Font OverridesIf set to a LanguageFontOverrides asset, the display will controls font settings on a per-language basis on all text components within it.
Override Font Size SettingsWhen set to true, all text components in the display which are set to use auto-sizing will use the minimum and maximum font sizes set in the Font Settings.
Min Font SizeThe minimum font size to use on all text components in the display when in auto-sizing mode.
Max Font SizeThe maximum font size to use on all text components in the display when in auto-sizing mode.

Option Buttons

Used to assign the Dialogue Buttons used for choosing options in the display. Any existing Dialogue Buttons used by the Option Display must be set here prior to entering Play mode. If buttons are dynamically created during runtime, they are automatically added to this list.

Animation Settings

These settings affect how the option display transitions between being hidden and being shown (as needed).

SettingDescription
Animation TypeWhen in NONE mode, the option panel will be hidden and shown immediately (when appropriate) rather than using a transition animation. If in FADE mode, all image and text components will be hidden and shown using alpha fading. The 'SLIDE' modes will cause the display to be shown and hidden by sliding it in and out of the canvas as needed.
Animation CurveAn animation curve which defines the timing curve for the animation.
Animation TimeThe amount of time the show/hide transition should take.
Return to Original PositionWhen in 'SLIDE' mode, if this is set to 'true', the display will be forced to return to its original position when being shown. If set to false, the display will move into the view of the canvas and stop once it is fully visible.

Images

The image components used by the option display. Assigning images here is optional since these references to the images are only used to apply styles to the display.

Option Display Listeners

Option Display Listeners can be added to this list to implement functionality based on Option Display related events, such as the options being set or an option being selected or chosen by the player.

Display Panel Events

Event NameDescription
On Hide StartCalled whenever the panel begins being hidden.
On Hide CompleteCalled whenever the panel has finished being hidden.
On Show StartCalled whenever the panel begins being shown.
On Show CompleteCalled whenever the panel finishes being shown.

Option Display Events

Event NameDescription
On Options SetCalled whenever the dialogue options to display are set on the option display.
On Option SelectedCalled whenever the player selects an option.
On Option ChangedCalled whenever the player switches their selection from one option to another.
On Option ChosenCalled whenever the player chooses/finalizes their option.